Unify syntax, add style checks, remove obsolete Python 2 leftovers

.github/get-numpy-version.py

@@ -2,13 +2,14 @@
 
 from __future__ import annotations
 
-import os
-import sys
 import typing
-from packaging import version
 from typing import NoReturn, Union
 
+import os
+import sys
+
 import numpy
+from packaging import version
 
 if typing.TYPE_CHECKING:
     from packaging.version import LegacyVersion, Version
@@ -26,7 +27,7 @@ def prev() -> NoReturn:
         sys.exit(os.EX_DATAERR)
 
     minor -= 1
-    print(f"{major}.{minor}.0")  # noqa: T001
+    print(f"{major}.{minor}.0")  # noqa: T201
     sys.exit(os.EX_OK)
 
 

.github/get_pypi_info.py

@@ -20,8 +20,8 @@ def get_info(package_name: str = "") -> dict:
     if package_name == "":
         raise ValueError("Package name not provided.")
     url = f"https://pypi.org/pypi/{package_name}/json"
-    print(f"Calling {url}")  # noqa: T001
-    resp = requests.get(url)
+    print(f"Calling {url}")  # noqa: T201
+    resp = requests.get(url, timeout = 30)
     if resp.status_code != 200:
         raise Exception(f"ERROR calling PyPI ({url}) : {resp}")
     resp = resp.json()
@@ -44,15 +44,15 @@ def replace_in_file(filepath: str, info: dict):
     ::filepath:: Path to meta.yaml, with filename.
     ::info:: Dict with information to populate.
     """
-    with open(filepath, "rt", encoding="utf-8") as fin:
+    with open(filepath, encoding = "utf-8") as fin:
         meta = fin.read()
     # Replace with info from PyPi
     meta = meta.replace("PYPI_VERSION", info["last_version"])
     meta = meta.replace("PYPI_URL", info["url"])
     meta = meta.replace("PYPI_SHA256", info["sha256"])
-    with open(filepath, "wt", encoding="utf-8") as fout:
+    with open(filepath, "wt", encoding = "utf-8") as fout:
         fout.write(meta)
-    print(f"File {filepath} has been updated with info from PyPi.")  # noqa: T001
+    print(f"File {filepath} has been updated with info from PyPi.")  # noqa: T201
 
 
 if __name__ == "__main__":
@@ -74,5 +74,5 @@ def replace_in_file(filepath: str, info: dict):
         )
     args = parser.parse_args()
     info = get_info(args.package)
-    print("Information of the last published PyPi package :", info["last_version"])  # noqa: T001
+    print("Information of the last published PyPi package :", info["last_version"])  # noqa: T201
     replace_in_file(args.filename, info)

CHANGELOG.md

@@ -1,5 +1,118 @@
 # Changelog
 
+# 36.0.0.rc1 [#1047](https://github.com/openfisca/openfisca-core/pull/1047)
+
+#### Technical changes
+
+- Document/honestify:
+  - Styles as enforced and skipped in `setup.cfg`
+  - Actual dependecy versions whith whom OpenFisca runs in py37-39 (note that
+    this library does not run with py36, py310, numpy v1.17, etc., which is not
+    product of any particular change introduced by this changeset)
+- Make style checks stricter and clearer to help developers contribute:
+  - Early returns are prefered for readability and performance
+    - Before:
+      ```py
+      if 1 > n:
+          var = something
+      else:
+          var = something_else
+
+      return var
+      ```
+    - After:
+      ```py
+      if 1 > n:
+          return something
+
+      return something_elses
+      ```
+  - Normalise the use of:
+    - Quotes is normalised to double-quotes
+    - `@staticmethod` when `self` is unused
+    - `except from` for better exception context
+    - `isinstance()` as per the best practice
+    - f-strings as per good practice
+  - Favour:
+    - `...` as a placeholder and `pass` for loops
+    - Relative to absolute imports to avoid circularity
+    - Import sorting as described in the [STYLEGUIDE](STYLEGUIDE.md)
+  - Avoid:
+    - Catch-all exceptions in favour of more specific ones
+    - Import aliases (so `np` becomes `numpy`)
+  - Remove:
+    - Code using `exec` because dangerous and hard to maintain
+  - Extract:
+    - Common imports to `commons.imports`
+- Most of these can be:
+  - Corrected automatically running `make format-style`
+  - Fixed by hand with the output of `make test` and `make style-check`
+
+#### New features
+
+- Rename and makes the following public (note this are not considered as
+  breking changes because methods were private, so renaming them to make
+  them public counts as actually adding a new publicly exposed method, while
+  removing a private method doesn't count as a breaking change):
+  - `Holder._to_array` to `Holder.to_array`
+  - `Holder._set` to `Holder.put`
+  - `Holder._memory_storage` to `Holder.memory_storage`
+  - `parameters._compose_name` to `parameters.compose_name`
+  - `parameters._validate_parameter` to `parameters.validate_parameter`
+  - `ParameterNodeAtInstant._name` to `ParameterNodeAtInstant.name`
+  - `ParameterNodeAtInstant._instant_str` to `ParameterNodeAtInstant.instant_str`
+  - `ParameterNodeAtInstant._children` to `ParameterNodeAtInstant.children`
+  - `Population._holders` to `Population.holders`
+  - `simulations._get_person_count` to `simulations.get_person_count`
+  - `Simulation._check_for_cycle` to `Simulation.check_for_cycle`
+  - `Simulation._check_period_consistency` to `Simulation.check_period_consistency`
+  - `FlatTracer._enter_calculation` to `FlatTracer.enter_calculation`
+  - `FlatTracer._exit_calculation` to `FlatTracer.exit_calculation`
+  - `FlatTracer._start_time` to `FlatTracer.start_time`
+  - `FlatTracer._end_time` to `FlatTracer.end_time`
+  - `PerformanceLog._json` to `PerformanceLog.json`
+- Add:
+ - `periods.year_start`
+ - `periods.year_end`
+- Extend:
+  - `test_runner.YamlItem.repr_failure` with a third argument `style` as per
+    the definition of the class it inherits from.
+
+#### Breaking changes
+
+- Expire deprecation of:
+  - The `Dummy` class, now provided by `commons`
+  - `formula_helpers`, now provided by `commons`
+  - `memory_config`, now provided by `experimental`
+  - `rates`, now provided by `commons`
+  - `Scale`, now provided by `ParameterScale`
+  - `Bracket`, now provided by `ParameterScaleBracket`
+  - `ValuesHistory`, now provided by `ParameterScale`
+  - `ParameterNotFound`, now provided by `ParameterNotFoundError`
+  - `VariableNameConflict`, now provided by `VariableNameConflictError`
+  - `VariableNotFound`, now provided by `VariableNotFoundError`
+  - `simulation_builder`, now provided by `simulations`
+  - `openfisca-run-test`, now provided by `openfisca test`
+  - `TaxBenefitSystem.new_scenario`, now provided by `SimulationBuilder`
+  - `AbstractRateTaxScale`, now provided by `RateTaxScaleLike`
+  - `AbstractTaxScale`, now provided by `TaxScaleLike`
+  - _In fine_, All errors that were not but are not under `errors`
+- Delete (no replacement):
+  - `scripts.measure_performance`
+  - `scripts.migrations.v16_2_to_v17`
+- Normalise the use of:
+  - `file_path` for file context-managers (implies argument name rename)
+
+#### Publising instructions
+
+Because this library has a circular depedency with `openfisca-country-template`
+and `openfisca-extension-template`, publish of this version requires:
+1. Publishing of one or many release candidates
+2. Publishing next major or `openfisca-country-template`
+3. Publishing next major or `openfisca-extension-template`
+4. Publishing next major of this library
+5. Publishing due diligence or unexpected outcome fixes as a release candidates
+
 ### 35.9.0 [#1150](https://github.com/openfisca/openfisca-core/pull/1150)
 
 #### New Features
@@ -383,7 +496,7 @@ Here is a subset of the deprecations that you might find in your model with some
   * Before `np.select([], [])` result was `0` (for a `default` argument value set to `0`).
     * Now, we have to check for empty conditions and, return `0` or the defined default argument value when we want to keep the same behavior.
   * Before, integer conditions where transformed to booleans.
-    * For example, `np.select([0, 1, 0], ['a', 'b', 'c'])` result was `array('b', dtype='<U21')`. Now, we have to update such code to: `np.select(np.array([0, 1, 0]).astype(bool), ['a', 'b', 'c'])`.
+    * For example, `np.select([0, 1, 0], ['a', 'b', 'c'])` result was `array('b', dtype = '<U21')`. Now, we have to update such code to: `np.select(np.array([0, 1, 0]).astype(bool), ['a', 'b', 'c'])`.
 * `np.linspace parameter num must be an integer.`
   * No surprise here, update the `num` parameter in [np.linspace](https://numpy.org/doc/1.18/reference/generated/numpy.linspace.html) in order to get an integer.
 * `Array order only accepts ‘C’, ‘F’, ‘A’, and ‘K’.`
@@ -2664,7 +2777,7 @@ For more information, check the [documentation](https://openfisca.org/doc/coding
 
     def reform_modify_parameters(parameters):
         file_path = os.path.join(dir_path, 'plf2016.yaml')
-        reform_parameters_subtree = load_parameter_file(name = 'plf2016', file_path=file_path)
+        reform_parameters_subtree = load_parameter_file(name = 'plf2016', file_path = file_path)
         parameters.add_child('plf2016', reform_parameters_subtree)
         return parameters
 
@@ -3262,14 +3375,14 @@ Unlike simple formulas, a `DatedVariable` have several functions. We thus need t
 
 ## 2.2.0
 
-* Implement simulation.calculate `print_trace=True` argument. Options: `max_depth` and `show_default_values`
+* Implement simulation.calculate `print_trace = True` argument. Options: `max_depth` and `show_default_values`
 
   Examples:
   ```python
-  simulation = scenario.new_simulation(trace=True)
-  simulation.calculate('irpp', 2014, print_trace=True)
-  simulation.calculate('irpp', 2014, print_trace=True, max_depth=-1)
-  simulation.calculate('irpp', 2014, print_trace=True, max_depth=-1, show_default_values=False)
+  simulation = scenario.new_simulation(trace = True)
+  simulation.calculate('irpp', 2014, print_trace = True)
+  simulation.calculate('irpp', 2014, print_trace = True, max_depth = -1)
+  simulation.calculate('irpp', 2014, print_trace = True, max_depth = -1, show_default_values = False)
   ```
 
 ## 2.1.0 – [diff](https://github.com/openfisca/openfisca-core/compare/2.0.3...2.0.4)

CONTRIBUTING.md

@@ -137,7 +137,7 @@ class Cache:
     """
 
     def __init__(self, type: str) -> None:
-        pass
+        ...
 
 ```
 
@@ -197,6 +197,4 @@ def get(self, key: str) -> Any:
 
     """
 
-    pass
-
 ```

README.md

@@ -40,8 +40,8 @@ git clone https://github.com/openfisca/openfisca-core.git
 cd openfisca-core
 python3 -m venv .venv
 source .venv/bin/activate
-pip install -U pip
-pip install --editable .[dev] --use-deprecated=legacy-resolver
+pip install --user pip
+pip install --editable ".[dev]"
 ```
 
 ### Installing `openfisca-core` with `conda`

openfisca_core/commons/__init__.py

@@ -12,14 +12,6 @@
     * :func:`.stringify_array`
     * :func:`.switch`
 
-Deprecated:
-    * :class:`.Dummy`
-
-Note:
-    The ``deprecated`` imports are transitional, in order to ensure non-breaking
-    changes, and could be removed from the codebase in the next
-    major release.
-
 Note:
     How imports are being used today::
 
@@ -53,15 +45,10 @@
 # Official Public API
 
 from .formulas import apply_thresholds, concat, switch  # noqa: F401
+from .imports import import_country_package, import_yaml  # noqa: F401
 from .misc import empty_clone, stringify_array  # noqa: F401
 from .rates import average_rate, marginal_rate  # noqa: F401
 
 __all__ = ["apply_thresholds", "concat", "switch"]
 __all__ = ["empty_clone", "stringify_array", *__all__]
 __all__ = ["average_rate", "marginal_rate", *__all__]
-
-# Deprecated
-
-from .dummy import Dummy  # noqa: F401
-
-__all__ = ["Dummy", *__all__]

openfisca_core/commons/formulas.py

@@ -79,12 +79,12 @@ def concat(this: ArrayLike[str], that: ArrayLike[str]) -> ArrayType[str]:
     if isinstance(this, numpy.ndarray) and \
        not numpy.issubdtype(this.dtype, numpy.str_):
 
-        this = this.astype('str')
+        this = this.astype("str")
 
     if isinstance(that, numpy.ndarray) and \
        not numpy.issubdtype(that.dtype, numpy.str_):
 
-        that = that.astype('str')
+        that = that.astype("str")
 
     return numpy.char.add(this, that)
 

openfisca_core/commons/imports.py

@@ -0,0 +1,48 @@
+from types import ModuleType
+from typing import Tuple
+
+import importlib
+import os
+import traceback
+import warnings
+
+import yaml
+
+from openfisca_core.warnings import LibYAMLWarning
+
+
+def import_country_package(country_package_name: str) -> ModuleType:
+    """Import a country package."""
+
+    try:
+        return importlib.import_module(country_package_name)
+
+    except ImportError as error:
+        message = os.linesep.join([
+            traceback.format_exc(),
+            f"Could not import module `{country_package_name}`. Are you sure",
+            "it is installed in your environment? If so, look at the stack",
+            "trace above to determine the origin of this error. See more at",
+            "<https://github.com/openfisca/country-template#installing>.",
+            os.linesep,
+            ])
+
+        raise ImportError(message) from error
+
+
+def import_yaml() -> Tuple[ModuleType, yaml.cyaml.CLoader]:
+    """Import the yaml library."""
+
+    try:
+        return yaml, yaml.__getattribute__("CLoader")
+
+    except AttributeError:
+        message = [
+            "libyaml is not installed in your environment.",
+            "This can make your test suite slower to run. Once you have",
+            "installed libyaml, run 'pip uninstall pyyaml && pip install",
+            "pyyaml --no-cache-dir' so that it is used in your Python",
+            "environment.",
+            ]
+        warnings.warn(" ".join(message), LibYAMLWarning)
+        return yaml, yaml.__getattribute__("SafeLoader")

openfisca_core/commons/misc.py

@@ -30,17 +30,18 @@ def empty_clone(original: T) -> T:
     """
 
     Dummy: object
-    new: T
+    dummy: T
 
     Dummy = type(
         "Dummy",
         (original.__class__,),
         {"__init__": lambda self: None},
         )
 
-    new = Dummy()
-    new.__class__ = original.__class__
-    return new
+    dummy = Dummy()
+    dummy.__class__ = original.__class__
+
+    return dummy
 
 
 def stringify_array(array: ArrayType) -> str: