ssb-klass-python 0.0.8__tar.gz → 0.0.10__tar.gz

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ssb-klass-python
-Version: 0.0.8
+Version: 0.0.10
 Summary: A Python package built on top of KLASS's API for retrieving classifications, codes, correspondences etc.
 Home-page: https://github.com/statisticsnorway/ssb-klass-python
 License: MIT
@@ -13,7 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: dapla-toolbelt (>=1.3.2)
+Requires-Dist: dapla-toolbelt (>=2.0.6)
 Requires-Dist: ipywidgets (>=8.0.6)
 Requires-Dist: pandas (>=1.5.3)
 Requires-Dist: pandas-stubs (>=2.1.1.230928)

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-klass-python"
-version = "0.0.8"
+version = "0.0.10"
 description = "A Python package built on top of KLASS's API for retrieving classifications, codes, correspondences etc."
 authors = ["Carl Corneil, ssb-pythonistas <ssb-pythonistas@ssb.no>"]
 license = "MIT"
@@ -16,7 +16,7 @@ Changelog = "https://github.com/statisticsnorway/ssb-klass-python/releases"
 
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
-dapla-toolbelt = ">=1.3.2"
+dapla-toolbelt = ">=2.0.6"
 python-dateutil = ">=2.8.2"
 toml = ">=0.10.2"
 ipywidgets = ">=8.0.6"
@@ -30,7 +30,7 @@ types-toml = ">=0.10.8.7"
 
 [tool.poetry.group.dev.dependencies]
 pygments = ">=2.10.0"
-black = { extras = ["jupyter"], version = ">=23.1.0" }
+black = { extras = ["jupyter"], version = ">=24.3.0" }
 coverage = { extras = ["toml"], version = ">=6.2" }
 darglint = ">=1.8.1"
 furo = ">=2021.11.12"
@@ -55,6 +55,7 @@ myst-parser = { version = ">=0.16.1" }
 [tool.pytest.ini_options]
 pythonpath = ["src"]
 
+
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]
 tests = ["tests", "*/tests"]
@@ -62,6 +63,7 @@ tests = ["tests", "*/tests"]
 [tool.coverage.run]
 branch = true
 source = ["klass", "tests"]
+relative_files = true
 
 [tool.coverage.report]
 show_missing = true
@@ -85,11 +87,22 @@ ignore_missing_imports = true
 force-exclude = true  # Apply excludes to pre-commit
 show-fixes = true
 src = ["src", "tests"]
-target-version = "py39"  # Minimum Python version supported
+target-version = "py310"  # Minimum Python version supported
+
+include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
+extend-exclude = [
+    "__pycache__",
+    "old",
+    ".ipynb_checkpoints",
+    "noxfile.py",
+    "docs/conf.py",
+]
 
 # Ruff rules may be customized as desired: https://docs.astral.sh/ruff/rules/
+[tool.ruff.lint]
 select = [
     "A",    # prevent using keywords that clobber python builtins
+    "ANN",  # check type annotations
     "B",    # bugbear: security warnings
     "D",    # documentation
     "E",    # pycodestyle
@@ -101,43 +114,42 @@ select = [
 ]
 ignore = [
     "ANN101", # Supress missing-type-self.
-    "D100",   # Supress undocumented-public-module. Only doc of public api required.
-    "E402",   # Supress module-import-not-at-top-of-file, needed in jupyter notebooks.
-    "E501",   # Supress line-too-long warnings: trust black's judgement on this one.
-]
-include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
-extend-exclude = [
-    "__pycache__",
-    "old",
-    ".ipynb_checkpoints",
-    "noxfile.py",
-    "docs/conf.py",
-    "*.ipynb",  # Custom ignore for klass-package, notebooks are only for "demo", waiting for a B018 ignore on notebooks in ruff
-    # https://github.com/astral-sh/ruff/pull/8872 <- has been merged in main, but not yet released?
+    "ANN102", # Supress missing-type-cls.
+    "ANN202", # Don't requiere return type annotation for private functions.
+    "ANN401", # Allow type annotation with type Any.
+     "D100",   # Supress undocumented-public-module. Only doc of public api required.
+     "E402",   # Supress module-import-not-at-top-of-file, needed in jupyter notebooks.
+     "E501",   # Supress line-too-long warnings: trust black's judgement on this one.
 ]
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 force-single-line = true
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 15
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"  # You can also use "numpy".
 
-[tool.ruff.pep8-naming]
+[tool.ruff.lint.pep8-naming]
 classmethod-decorators = ["classmethod", "validator", "root_validator", "pydantic.validator"]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "*/__init__.py" = ["F401"]
 "**/tests/*" = [
-    # asserts are encouraged in pytest
-    "S101",
-    # return annotations don't add value for test functions
-    "ANN201",
-    # docstrings are overkill for test functions
+    "ANN001",  # type annotations don't add value for test functions
+    "ANN002",  # type annotations don't add value for test functions
+    "ANN003",  # type annotations don't add value for test functions
+    "ANN201",  # type annotations don't add value for test functions
+    "ANN204",  # type annotations don't add value for test functions
+    "ANN205",  # type annotations don't add value for test functions
+    "ANN206",  # type annotations don't add value for test functions
+    "D100",    # docstrings are overkill for test functions
+    "D101",
+    "D102",
     "D103",
     "D100",
+    "S101",    # asserts are encouraged in pytest
 ]
 
 [build-system]

ssb_klass_python-0.0.10/src/klass/__init__.py

@@ -0,0 +1,97 @@
+"""A Python package built on top of Statistics Norway's code- and classification-system "KLASS".
+
+The package aims to make Klass's API for retrieving data easier to use by re-representing Klass's internal hierarchy as python-classes.
+Containing methods for easier traversal down, search classes and widgets, reasonable defaults to parameters etc.
+Where data is possible to fit into pandas DataFrames, this will be preferred, but hirerachical data will be kept as json / dict structure.
+"""
+
+import importlib
+import importlib.metadata
+
+import toml
+
+
+def _try_getting_pyproject_toml(e: Exception | None = None) -> str:
+    if e is None:
+        passed_excep: Exception = Exception("")
+    else:
+        passed_excep = e
+    try:
+        version: str = toml.load("pyproject.toml")["tool"]["poetry"]["version"]
+        return version
+    except Exception as e:
+        version_missing: str = "0.0.0"
+        print(
+            f"Error from ssb-klass-pythons __init__, not able to get version-number, setting it to {version_missing}: {passed_excep}"
+        )
+        return version_missing
+
+
+# Gets the installed version from pyproject.toml, then there is no need to update this file
+try:
+    __version__ = importlib.metadata.version("ssb-klass-python")
+except importlib.metadata.PackageNotFoundError as e:
+    __version__ = _try_getting_pyproject_toml(e)
+
+
+from klass.classes.classification import KlassClassification
+from klass.classes.codes import KlassCodes
+from klass.classes.correspondence import KlassCorrespondence
+from klass.classes.family import KlassFamily
+from klass.classes.search import KlassSearchClassifications
+from klass.classes.search import KlassSearchFamilies
+from klass.classes.variant import KlassVariant
+from klass.classes.variant import KlassVariantSearchByName
+from klass.classes.version import KlassVersion
+from klass.requests.klass_requests import changes
+from klass.requests.klass_requests import classification_by_id
+from klass.requests.klass_requests import classification_search
+from klass.requests.klass_requests import classificationfamilies
+from klass.requests.klass_requests import classificationfamilies_by_id
+from klass.requests.klass_requests import classifications
+from klass.requests.klass_requests import codes
+from klass.requests.klass_requests import codes_at
+from klass.requests.klass_requests import correspondence_table_by_id
+from klass.requests.klass_requests import corresponds
+from klass.requests.klass_requests import corresponds_at
+from klass.requests.klass_requests import variant
+from klass.requests.klass_requests import variant_at
+from klass.requests.klass_requests import variants_by_id
+from klass.requests.klass_requests import version_by_id
+from klass.requests.sections import sections_dict
+from klass.requests.sections import sections_list
+from klass.utility.classification import get_classification
+from klass.utility.codes import get_codes
+from klass.widgets.search_ipywidget import search_classification
+
+__all__ = [
+    "classifications",
+    "classification_search",
+    "classification_by_id",
+    "codes",
+    "codes_at",
+    "version_by_id",
+    "variant",
+    "variant_at",
+    "variants_by_id",
+    "corresponds",
+    "corresponds_at",
+    "correspondence_table_by_id",
+    "changes",
+    "classificationfamilies",
+    "classificationfamilies_by_id",
+    "sections_list",
+    "sections_dict",
+    "KlassCodes",
+    "KlassCorrespondence",
+    "KlassClassification",
+    "KlassFamily",
+    "KlassSearchClassifications",
+    "KlassSearchFamilies",
+    "KlassVariant",
+    "KlassVariantSearchByName",
+    "KlassVersion",
+    "get_codes",
+    "get_classification",
+    "search_classification",
+]

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/src/klass/classes/classification.py

@@ -58,7 +58,7 @@ class KlassClassification:
 
     def __init__(
         self, classification_id: str, language: str = "nb", include_future: bool = False
-    ):
+    ) -> None:
         """Get the data for the classification from the API."""
         self.classification_id = classification_id
         self.language = language

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/src/klass/classes/codes.py

@@ -48,7 +48,7 @@ class KlassCodes:
         presentation_name_pattern: str = "",
         language: str = "nb",
         include_future: bool = False,
-    ):
+    ) -> None:
         """Get the data from the KLASS-api belonging to the code-list."""
         self.classification_id = classification_id
         if not from_date:
@@ -187,7 +187,7 @@ class KlassCodes:
                 value = "presentationName"
             else:
                 value = "name"
-        mapping = dict(zip(self.data[key], self.data[value]))
+        mapping = dict(zip(self.data[key], self.data[value], strict=False))
         if other:
             mapping = defaultdict(lambda: other, mapping)
         return mapping
@@ -212,7 +212,8 @@ class KlassCodes:
             keep = ["code", "name"]
         df = pd.DataFrame()
         lev_previous = 1
-        for lev in self.data["level"].unique():
+        sorted_levels = sorted(self.data["level"].unique())
+        for lev in sorted_levels:
             temp = self.data[self.data["level"] == lev].copy()
             temp.columns = [f"{c}_{lev}" for c in temp.columns]
             if len(df):

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/src/klass/classes/correspondence.py

@@ -56,7 +56,7 @@ class KlassCorrespondence:
         contain_quarter: int = 0,
         language: str = "nb",
         include_future: bool = False,
-    ):
+    ) -> None:
         """Get the correspondence-data from the API."""
         self.correspondence_id = correspondence_id
         self.source_classification_id = source_classification_id
@@ -197,7 +197,7 @@ class KlassCorrespondence:
         Returns:
             dict | defaultdict: The dictionary of the correspondence.
         """
-        mapping = dict(zip(self.data[key], self.data[value]))
+        mapping = dict(zip(self.data[key], self.data[value], strict=False))
         if other:
             mapping = defaultdict(lambda: other, mapping)
         return mapping

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/src/klass/classes/family.py

@@ -20,7 +20,7 @@ class KlassFamily:
         family_id (str): The ID of the family.
     """
 
-    def __init__(self, family_id: str):
+    def __init__(self, family_id: str) -> None:
         """Get the family data from the klass-api, setting it as attributes on the object."""
         self.family_id = family_id
         # Setting for mypy

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/src/klass/classes/search.py

@@ -32,7 +32,7 @@ class KlassSearchClassifications:
         include_codelists: bool = True,  # Opposite default of API, cause why not
         ssbsection: str = "",
         no_dupes: bool = False,
-    ):
+    ) -> None:
         """Get data from the KLASS-api, setting it as attributes on this object."""
         self.query = query
         self.include_codelists = include_codelists
@@ -168,7 +168,7 @@ class KlassSearchFamilies:
         ssbsection: str = "",
         include_codelists: bool = False,
         language: str = "nb",
-    ):
+    ) -> None:
         """Get data from the KLASS-api, setting it as attributes on this object."""
         self.ssbsection = ssbsection
         self.include_codelists = include_codelists

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/src/klass/classes/variant.py

@@ -49,7 +49,7 @@ class KlassVariant:
         variant_id: str,
         select_level: int = 0,
         language: str = "nb",
-    ):
+    ) -> None:
         """Get the data from the KLASS-api to populate this objects attributes."""
         self.variant_id = variant_id
         self.select_level = select_level
@@ -169,7 +169,7 @@ class KlassVariantSearchByName:
         presentation_name_pattern: str = "",
         language: str = "nb",
         include_future: bool = False,
-    ):
+    ) -> None:
         """Get the data from the KLASS-api, setting it as attributes on the object."""
         self.classification_id = classification_id
         self.variant_name = variant_name

{ssb_klass_python-0.0.8 → ssb_klass_python-0.0.10}/src/klass/classes/version.py

@@ -41,7 +41,7 @@ class KlassVersion:
         select_level: int = 0,
         language: str = "nb",
         include_future: bool = False,
-    ):
+    ) -> None:
         """Set up the object with data from the KLASS-API."""
         self.version_id = version_id
         self.select_level = select_level

ssb_klass_python-0.0.8/src/klass/__init__.py

@@ -1,75 +0,0 @@
-"""A Python package built on top of Statistics Norway's code- and classification-system "KLASS".
-
-The package aims to make Klass's API for retrieving data easier to use by re-representing Klass's internal hierarchy as python-classes.
-Containing methods for easier traversal down, search classes and widgets, reasonable defaults to parameters etc.
-Where data is possible to fit into pandas DataFrames, this will be preferred, but hirerachical data will be kept as json / dict structure.
-"""
-
-import importlib
-
-import toml
-
-
-# Split into function for testing
-def _try_getting_pyproject_toml(e: Exception | None = None) -> str:
-    if e is None:
-        passed_excep: Exception = Exception("")
-    else:
-        passed_excep = e
-    try:
-        version: str = toml.load("../pyproject.toml")["tool"]["poetry"]["version"]
-        return version
-    except Exception as e:
-        version_missing: str = "0.0.0"
-        print(
-            f"Error from ssb-klass-pythons __init__, not able to get version-number, setting it to {version_missing}: {passed_excep}"
-        )
-        return version_missing
-
-
-# Gets the installed version from pyproject.toml, then there is no need to update this file
-try:
-    __version__ = importlib.metadata.version("ssb-klass-python")
-except importlib.metadata.PackageNotFoundError as e:
-    __version__ = _try_getting_pyproject_toml(e)
-
-
-__all__ = []
-
-# Everything we want to be directly importable from under "klass"-package
-local_imports = {
-    "requests.klass_requests": [
-        "classifications",
-        "classification_search",
-        "classification_by_id",
-        "codes",
-        "codes_at",
-        "version_by_id",
-        "variant",
-        "variant_at",
-        "variants_by_id",
-        "corresponds",
-        "corresponds_at",
-        "correspondence_table_by_id",
-        "changes",
-        "classificationfamilies",
-        "classificationfamilies_by_id",
-    ],
-    "classes.codes": ["KlassCodes"],
-    "classes.correspondence": ["KlassCorrespondence"],
-    "classes.classification": ["KlassClassification"],
-    "classes.family": ["KlassFamily"],
-    "classes.search": ["KlassSearchClassifications", "KlassSearchFamilies"],
-    "requests.sections": ["sections_list", "sections_dict"],
-    "classes.variant": ["KlassVariant", "KlassVariantSearchByName"],
-    "classes.version": ["KlassVersion"],
-    "utility.codes": ["get_codes"],
-    "utility.classification": ["get_classification"],
-    "widgets.search_ipywidget": ["search_classification"],
-}
-
-# Loop that imports local files into this namespace and appends to __all__ for star imports
-for file, funcs in local_imports.items():
-    for func in funcs:
-        globals()[func] = getattr(importlib.import_module(f"klass.{file}", func), func)
-        __all__.append(func)