Skip to main content

Standalone Variable Static Typing

Project description

Standalone Variable Static Typing (svst)

Full-on Python Static Typing

Python Version Stable Version Downloads Build Status Documentation Status Checked with mypy Code style: black Linting: ruff

Standalone Variable Static Type Checker using Abstract Syntax Trees

Why?

Python is an amazing programming language; my favorite one for a lot of reasons. With the broad functionality, ease of use, development speed, and friendly community; I could be here all day saying good things about it.

One of the major selling points the dynamic typing, at least initially.

When you start scaling Python and using it on huge projects dealing with a lot of different entities and flows you can make a mistake and find the pitfall of not knowing why your variable is not behaving as you wish it was; between other issues (if you try to statically type an existing codebase with mypy you'll find how bad your code is in terms of type consistency; at least that happened to me).

After fixing a huge mess I wanted to go a step further and not only enforce the typing of functions/classes input and output but to type my standalone variables as well until I found that mypy doesn't check that because his goal is to find the balance between dynamic and static typing; I wanted to go full-on static.

At first, I created a simple file to do this, but soon I found that I needed a proper implementation of this to spread to all my projects and possibly help the community.

I'd like to extend immense gratitude to @alphasensei for pioneering the research and developing the initial proof of concept for this library.

This is an attempt of bringing full-on static typing to Python and, with it, much more robust codebases.

Quick start

Svst can be installed using pip:

python3 -m pip install -U svst

You can type-check the standalone variables of a program like this:

svst PROGRAM

You can type-check a program including the mypy functionality like this as well:

svst --mypy PROGRAM

Integrations

  • Vim
  • PyCharm
  • VS Code
  • pre-commit

Documentation

Contributing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

svst-0.1.1.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

svst-0.1.1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file svst-0.1.1.tar.gz.

File metadata

  • Download URL: svst-0.1.1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for svst-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3ba0a616e332a7cca9e6b823cd1265898c69476c2e3bc73088e263d0698f4d25
MD5 6384aba3cc87dae3f86ba53b4ce4249c
BLAKE2b-256 3de28279049f95531c66782baced90d37441c22814d0ec0a68e0385fb619b288

See more details on using hashes here.

File details

Details for the file svst-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: svst-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for svst-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f2ebadaae43ed34ba05ee407c10ebe9357a56540cb1b80a54bbfddd2f1495630
MD5 3e0851cd9f2c6b2e4f6d4ee726758786
BLAKE2b-256 d6edd337f771dd23a8b119edbdaa482a90a81f4519dd82f64ab2cccc78af93ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page