pycroscope 0.1.0__tar.gz

pycroscope-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

pycroscope-0.1.0/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: pycroscope
+Version: 0.1.0
+Summary: A static analyzer for Python
+Home-page: https://github.com/JelleZijlstra/pycroscope
+Author: Jelle Zijlstra
+Author-email: jelle.zijlstra@gmail.com
+License: Apache Software License
+Keywords: type checker static analysis
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: asynq
+Requires-Dist: qcore>=0.5.1
+Requires-Dist: ast_decompiler>=0.4.0
+Requires-Dist: typeshed_client>=2.1.0
+Requires-Dist: typing_extensions>=4.12.0
+Requires-Dist: codemod
+Requires-Dist: tomli>=1.1.0
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: mypy_extensions; extra == "tests"
+Requires-Dist: attrs; extra == "tests"
+Requires-Dist: pydantic; extra == "tests"
+Requires-Dist: annotated-types; extra == "tests"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# pycroscope
+
+Pycroscope is a semi-static type checker for Python code. Like a static type checker (e.g., mypy or pyright), it
+detects type errors in your code so bugs can be found before they reach production. Unlike such tools, however,
+it imports the modules it type checks, enabling pycroscope to understand many dynamic constructs that other type
+checkers will reject. This property also makes it possible to extend pycroscope with plugins that interact directly
+with your code.
+
+Pycroscope is a friendly fork of [pyanalyze](https://github.com/quora/pyanalyze).
+
+## Usage
+
+You can install pycroscope with:
+
+```bash
+$ pip install pycroscope
+```
+
+Once it is installed, you can run pycroscope on a Python file or package as follows:
+
+```bash
+$ python -m pycroscope file.py
+$ python -m pycroscope package/
+```
+
+But note that this will try to import all Python files it is passed. If you have scripts that perform operations without `if __name__ == "__main__":` blocks, pycroscope may end up executing them.
+
+In order to run successfully, pycroscope needs to be able to import the code it checks. To make this work you may have to manually adjust Python's import path using the `$PYTHONPATH` environment variable.
+
+For quick experimentation, you can also use the `-c` option to directly type check a piece of code:
+
+```
+$ python -m pycroscope -c 'import typing; typing.reveal_type(1)'
+Runtime type is 'int'
+
+Revealed type is 'Literal[1]' (code: reveal_type)
+In <code> at line 1
+   1: import typing; typing.reveal_type(1)
+                                        ^
+```
+
+### Configuration
+
+Pycroscope has a number of command-line options, which you can see by running `python -m pycroscope --help`. Important ones include `-f`, which runs an interactive prompt that lets you examine and fix each error found by pycroscope, and `--enable`/`--disable`, which enable and disable specific error codes.
+
+Configuration through a `pyproject.toml` file is also supported. See
+[the documentation](https://pycroscope.readthedocs.io/en/latest/configuration.html) for
+details.
+
+### Extending pycroscope
+
+One of the main ways to extend pycroscope is by providing a specification for a particular function. This allows you to run arbitrary code that inspects the arguments to the function and raises errors if something is wrong.
+
+As an example, suppose your codebase contains a function `database.run_query()` that takes as an argument a SQL string, like this:
+
+```python
+database.run_query("SELECT answer, question FROM content")
+```
+
+You want to detect when a call to `run_query()` contains syntactically invalid SQL or refers to a non-existent table or column. You could set that up with code like this:
+
+```python
+from pycroscope.error_code import ErrorCode
+from pycroscope.signature import CallContext, Signature, SigParameter
+from pycroscope.value import KnownValue, TypedValue, AnyValue, AnySource, Value
+
+from database import run_query, parse_sql
+
+
+def run_query_impl(ctx: CallContext) -> Value:
+    sql = ctx.vars["sql"]
+    if not isinstance(sql, KnownValue) or not isinstance(sql.val, str):
+        ctx.show_error(
+            "Argument to run_query() must be a string literal",
+            ErrorCode.incompatible_call,
+        )
+        return AnyValue(AnySource.error)
+
+    try:
+        parsed = parse_sql(sql)
+    except ValueError as e:
+        ctx.show_error(
+            f"Invalid sql passed to run_query(): {e}",
+            ErrorCode.incompatible_call,
+        )
+        return AnyValue(AnySource.error)
+
+    # check that the parsed SQL is valid...
+
+    # pycroscope will use this as the inferred return type for the function
+    return TypedValue(list)
+
+
+# in pyproject.toml, set:
+# known_signatures = ["<module>.get_known_argspecs"]
+def get_known_argspecs(arg_spec_cache):
+    return {
+        # This infers the parameter types and names from the function signature
+        run_query: arg_spec_cache.get_argspec(
+            run_query, impl=run_query_impl
+        ),
+        # You can also write the signature manually
+        run_query: Signature.make(
+            [SigParameter("sql", annotation=TypedValue(str))],
+            callable=run_query,
+            impl=run_query_impl,
+        ),
+    }
+```
+
+### Supported features
+
+Pycroscope generally aims to implement [the Python typing spec](https://typing.readthedocs.io/en/latest/spec/index.html),
+but support for some features is incomplete. See [the documentation](https://pycroscope.readthedocs.io/en/latest/)
+for details.
+
+### Ignoring errors
+
+Sometimes pycroscope gets things wrong and you need to ignore an error it emits. This can be done as follows:
+
+- Add `# static analysis: ignore` on a line by itself before the line that generates the error.
+- Add `# static analysis: ignore` at the end of the line that generates the error.
+- Add `# static analysis: ignore` at the top of the file; this will ignore errors in the entire file.
+
+You can add an error code, like `# static analysis: ignore[undefined_name]`, to ignore only a specific error code. This does not work for whole-file ignores. If the `bare_ignore` error code is turned on, pycroscope will emit an error if you don't specify an error code on an ignore comment.
+
+Pycroscope does not currently support the standard `# type: ignore` comment syntax.
+
+### Python version support
+
+Pycroscope supports all versions of Python that have not reached end-of-life. Because it imports the code it checks, you have to run it using the same version of Python you use to run your code.
+
+## Contributing
+
+We welcome your contributions. See [CONTRIBUTING.md](https://github.com/JelleZijlstra/pycroscope/blob/master/CONTRIBUTING.md)
+for how to get started.
+
+## Documentation
+
+Documentation is available on [GitHub](https://github.com/JelleZijlstra/pycroscope/tree/master/docs).

pycroscope-0.1.0/README.md

@@ -0,0 +1,140 @@
+# pycroscope
+
+Pycroscope is a semi-static type checker for Python code. Like a static type checker (e.g., mypy or pyright), it
+detects type errors in your code so bugs can be found before they reach production. Unlike such tools, however,
+it imports the modules it type checks, enabling pycroscope to understand many dynamic constructs that other type
+checkers will reject. This property also makes it possible to extend pycroscope with plugins that interact directly
+with your code.
+
+Pycroscope is a friendly fork of [pyanalyze](https://github.com/quora/pyanalyze).
+
+## Usage
+
+You can install pycroscope with:
+
+```bash
+$ pip install pycroscope
+```
+
+Once it is installed, you can run pycroscope on a Python file or package as follows:
+
+```bash
+$ python -m pycroscope file.py
+$ python -m pycroscope package/
+```
+
+But note that this will try to import all Python files it is passed. If you have scripts that perform operations without `if __name__ == "__main__":` blocks, pycroscope may end up executing them.
+
+In order to run successfully, pycroscope needs to be able to import the code it checks. To make this work you may have to manually adjust Python's import path using the `$PYTHONPATH` environment variable.
+
+For quick experimentation, you can also use the `-c` option to directly type check a piece of code:
+
+```
+$ python -m pycroscope -c 'import typing; typing.reveal_type(1)'
+Runtime type is 'int'
+
+Revealed type is 'Literal[1]' (code: reveal_type)
+In <code> at line 1
+   1: import typing; typing.reveal_type(1)
+                                        ^
+```
+
+### Configuration
+
+Pycroscope has a number of command-line options, which you can see by running `python -m pycroscope --help`. Important ones include `-f`, which runs an interactive prompt that lets you examine and fix each error found by pycroscope, and `--enable`/`--disable`, which enable and disable specific error codes.
+
+Configuration through a `pyproject.toml` file is also supported. See
+[the documentation](https://pycroscope.readthedocs.io/en/latest/configuration.html) for
+details.
+
+### Extending pycroscope
+
+One of the main ways to extend pycroscope is by providing a specification for a particular function. This allows you to run arbitrary code that inspects the arguments to the function and raises errors if something is wrong.
+
+As an example, suppose your codebase contains a function `database.run_query()` that takes as an argument a SQL string, like this:
+
+```python
+database.run_query("SELECT answer, question FROM content")
+```
+
+You want to detect when a call to `run_query()` contains syntactically invalid SQL or refers to a non-existent table or column. You could set that up with code like this:
+
+```python
+from pycroscope.error_code import ErrorCode
+from pycroscope.signature import CallContext, Signature, SigParameter
+from pycroscope.value import KnownValue, TypedValue, AnyValue, AnySource, Value
+
+from database import run_query, parse_sql
+
+
+def run_query_impl(ctx: CallContext) -> Value:
+    sql = ctx.vars["sql"]
+    if not isinstance(sql, KnownValue) or not isinstance(sql.val, str):
+        ctx.show_error(
+            "Argument to run_query() must be a string literal",
+            ErrorCode.incompatible_call,
+        )
+        return AnyValue(AnySource.error)
+
+    try:
+        parsed = parse_sql(sql)
+    except ValueError as e:
+        ctx.show_error(
+            f"Invalid sql passed to run_query(): {e}",
+            ErrorCode.incompatible_call,
+        )
+        return AnyValue(AnySource.error)
+
+    # check that the parsed SQL is valid...
+
+    # pycroscope will use this as the inferred return type for the function
+    return TypedValue(list)
+
+
+# in pyproject.toml, set:
+# known_signatures = ["<module>.get_known_argspecs"]
+def get_known_argspecs(arg_spec_cache):
+    return {
+        # This infers the parameter types and names from the function signature
+        run_query: arg_spec_cache.get_argspec(
+            run_query, impl=run_query_impl
+        ),
+        # You can also write the signature manually
+        run_query: Signature.make(
+            [SigParameter("sql", annotation=TypedValue(str))],
+            callable=run_query,
+            impl=run_query_impl,
+        ),
+    }
+```
+
+### Supported features
+
+Pycroscope generally aims to implement [the Python typing spec](https://typing.readthedocs.io/en/latest/spec/index.html),
+but support for some features is incomplete. See [the documentation](https://pycroscope.readthedocs.io/en/latest/)
+for details.
+
+### Ignoring errors
+
+Sometimes pycroscope gets things wrong and you need to ignore an error it emits. This can be done as follows:
+
+- Add `# static analysis: ignore` on a line by itself before the line that generates the error.
+- Add `# static analysis: ignore` at the end of the line that generates the error.
+- Add `# static analysis: ignore` at the top of the file; this will ignore errors in the entire file.
+
+You can add an error code, like `# static analysis: ignore[undefined_name]`, to ignore only a specific error code. This does not work for whole-file ignores. If the `bare_ignore` error code is turned on, pycroscope will emit an error if you don't specify an error code on an ignore comment.
+
+Pycroscope does not currently support the standard `# type: ignore` comment syntax.
+
+### Python version support
+
+Pycroscope supports all versions of Python that have not reached end-of-life. Because it imports the code it checks, you have to run it using the same version of Python you use to run your code.
+
+## Contributing
+
+We welcome your contributions. See [CONTRIBUTING.md](https://github.com/JelleZijlstra/pycroscope/blob/master/CONTRIBUTING.md)
+for how to get started.
+
+## Documentation
+
+Documentation is available on [GitHub](https://github.com/JelleZijlstra/pycroscope/tree/master/docs).

pycroscope-0.1.0/pycroscope/__init__.py

@@ -0,0 +1,73 @@
+"""
+
+pycroscope is a package for Python static analysis.
+
+"""
+
+# ignore unused import errors
+# flake8: noqa
+
+from . import (
+    analysis_lib,
+    annotated_types,
+    annotations,
+    arg_spec,
+    ast_annotator,
+    asynq_checker,
+    boolability,
+    checker,
+    error_code,
+    extensions,
+    find_unused,
+    functions,
+    implementation,
+    name_check_visitor,
+    node_visitor,
+    options,
+    patma,
+    predicates,
+    reexport,
+    safe,
+    runtime,
+    shared_options,
+    signature,
+    stacked_scopes,
+    suggested_type,
+    tests,
+    type_object,
+    typeshed,
+    typevar,
+    value,
+    yield_checker,
+)
+from .find_unused import used as used
+from .value import assert_is_value as assert_is_value, dump_value as dump_value
+
+# Exposed as APIs
+used(ast_annotator)
+used(assert_is_value)
+used(dump_value)
+used(extensions.LiteralOnly)
+used(extensions.NoAny)
+used(extensions.overload)
+used(extensions.evaluated)
+used(extensions.is_provided)
+used(extensions.is_keyword)
+used(extensions.is_positional)
+used(extensions.is_of_type)
+used(extensions.show_error)
+used(extensions.has_extra_keys)
+used(extensions.EnumName)
+used(extensions.ValidRegex)
+used(value.UNRESOLVED_VALUE)  # keeping it around for now just in case
+used(reexport)
+used(patma)
+used(checker)
+used(suggested_type)
+used(options)
+used(shared_options)
+used(functions)
+used(predicates)
+used(typevar)
+used(annotated_types)
+used(runtime)

pycroscope-0.1.0/pycroscope/__main__.py

@@ -0,0 +1,16 @@
+import os
+import sys
+
+from pycroscope.name_check_visitor import NameCheckVisitor
+
+
+def main() -> None:
+    if os.name == "nt":
+        # Enable ANSI color codes for Windows cmd using this strange workaround
+        # ( see https://github.com/python/cpython/issues/74261 )
+        os.system("")
+    sys.exit(NameCheckVisitor.main())
+
+
+if __name__ == "__main__":
+    main()