gus-caribe / voidsafe Goto Github PK

• Implement Jupyter Notebooks to /examples directory, including tabs to compare Python codeblocks with other null-aware languages;
• Replace examples cited on README.md for simpler ones;

Add instructions about installing the package via PyPi.

Change "nonesafe" directory name to "voidsafe".

Do what's required to remove the following warning that appears while installing the package:

DEPRECATION: voidsafe is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559

Adding VS as an alias for VOIDSAFE for semantic purposes.

• Making adaptations allowing the module to run on the oldest possible Python version, without compromising with its behavior.

• Link special terms to docs.caribesphaneron.com tags;
• Detach definitions from docstrings;

In the Python files it's a best practice to include the encoding on which that file was written for the interpreter to be "sure" of the encoding it will use to read the file.

It's typically the first line (or second, after shebang) of the file.

Here's an example (with shebang):

#!/usr/bin/python3
# -*- coding: UTF-8 -*-

When performing a coalescing assignment like the following, the protected values aren't being unwrapped:

foo: dict = {'bar': None}
VoidSafe(foo)['bar'] = ifnone << "default"

• Publish releases when committing to a version branch;
• Publish package to PiPy when a release is published;
• Perform unit tests before approving.

• Cover all operations with Unit Tests;

• Finish adding docstrings to the declarations;
• Finish adding repr and str implementations;
• Elaborating /examples directory;
• Adding Examples to README.md;
• Elaborating API.md file;
• Adjusting README.md;

Include the Project containing the basic features, without unit tests covered.

The deliverable will be released as v0.1.0.

• Adding support for Pylint Conventions.

• Organize directory hierarchy, making it easy to distinguish resources by scope.

The examples files should have the "shebang" line indicating the binary that should be used to execute that specific file or it would have to be indicated as "globally" for all example files in the readme of the project indicating that all the examples should use that binary.

Examples:

• Within the .py files, first line should be "#!/usr/bin/python3"
• In the readme file it could have the indication for executing examples: $(which python3) <example.py>

Problem

• Type Union generated by "linter hacking" doesn't allow coalescing with IFNDEF.

Suggestion to Solve It

• Allowing Any as _LeftType of _UndefinedCoalesce.