Skip to content

Commit

Permalink
Revise README and CHANGELOG files
Browse files Browse the repository at this point in the history
  • Loading branch information
mir-am committed Mar 4, 2021
1 parent ccebc7b commit 00cc534
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
17 changes: 8 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ All notable changes to the [LibSA4Py](https://github.com/saltudelft/libsa4py) to

## [Unreleased]

## [0.1.0] - 2021-03-03
## [0.1.0] - 2021-03-04

### Added
#### Pipeline
Expand All @@ -16,7 +16,7 @@ All notable changes to the [LibSA4Py](https://github.com/saltudelft/libsa4py) to
- Throwing `NullProjectException` for projects that have no source code files.

#### AST-based Extractor
- Creating a normalized Seq2Seq representation of a source code file aligned with a sequence types of identifiers.
- Creating a normalized Seq2Seq representation of a source code file aligned with a sequence of identifiers' type.
- Extracting import names of a module.
- Extracting the name of global variables in a module with their type annotations (if present).
- Calculating type annotation coverage for the whole project and its source code files.
Expand All @@ -25,22 +25,21 @@ All notable changes to the [LibSA4Py](https://github.com/saltudelft/libsa4py) to
- Extracting the name of functions in a module or in a class.
- Extracting the name of functions' parameters and their type annotations (if present).
- Extracting return expressions in functions.
- Extracting the occurrence of a function's parameters in in the function's body.
- Extracting the occurrence of a function's parameters in the function's body.
- Extracting the return type of functions (if present).
- Extracting docstring for functions' parameters and their return type.
- Extracting short and long description of functions in their docstring.
- Extracting short and long descriptions of functions in their docstring.

#### AST-based Transformers
- Adding space to around source code tokens for better tokenization.
- Adding space around source code tokens for better tokenization.
- Removing comment and docstring from source code for its normalized Seq2Seq representation.
- Removing string literals from source code for its normalized Seq2Seq representation.
- Removing numeric literals from source code for its normalized Seq2Seq representation.
- Removing type annotations from source code for its normalized Seq2Seq representation.
- Propagating the type of functions' parameters in the function body and module-level constants

- Propagating the type of functions' parameters in the function body and module-level constants.

### Fixed
- A special case where an uninitialized variables with types caused exceptions.
- A special case where uninitialized variables with types caused exceptions.
- A case where variables in a tuple couldn't be extracted in multiple assignments.
- Handling nested tuples in multiple assignments for extracting var names.
- A case where a type-annotated class attribute is not initialized for removing its type
- A case where a type-annotated class attribute is not initialized for removing its type.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# LibSA4Py
It is a static analysis library for Python, which extracts type hints and features for training ML-based type inference models.
# Intro
`LibSA4Py` is a static analysis library for Python, which extracts type hints and features for training ML-based type inference models.

- [Requirements](#requirements)
- [Quick Installation](#quick-installation)
Expand Down

0 comments on commit 00cc534

Please sign in to comment.