Merge branch 'main' into saving_jox

docs/reference.md

@@ -15,6 +15,24 @@ delete the .rst file afterwards.
 ssb\_konjunk package
 ====================
 
+Submodules
+----------
+
+ssb\_konjunk.data\_formating module
+-----------------------------------
+
+.. automodule:: ssb_konjunk.data_formating
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.fame module
+------------------------
+
+.. automodule:: ssb_konjunk.fame
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 ssb\_konjunk.functions module
 -----------------------------
@@ -31,3 +49,27 @@ ssb\_konjunk.prompts module
    :members:
    :undoc-members:
    :show-inheritance:
+
+ssb\_konjunk.timestamp module
+-----------------------------
+
+.. automodule:: ssb_konjunk.timestamp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.xml\_handling module
+---------------------------------
+
+.. automodule:: ssb_konjunk.xml_handling
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ssb_konjunk
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/ssb_konjunk.rst

@@ -0,0 +1,61 @@
+ssb\_konjunk package
+====================
+
+Submodules
+----------
+
+ssb\_konjunk.data\_formating module
+-----------------------------------
+
+.. automodule:: ssb_konjunk.data_formating
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.fame module
+------------------------
+
+.. automodule:: ssb_konjunk.fame
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.functions module
+-----------------------------
+
+.. automodule:: ssb_konjunk.functions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.prompts module
+---------------------------
+
+.. automodule:: ssb_konjunk.prompts
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.timestamp module
+-----------------------------
+
+.. automodule:: ssb_konjunk.timestamp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ssb\_konjunk.xml\_handling module
+---------------------------------
+
+.. automodule:: ssb_konjunk.xml_handling
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ssb_konjunk
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-konjunk"
-version = "0.1.1"
+version = "0.1.2"
 description = "SSB Konjunk"
 authors = ["Edvard Garmannslund <[email protected]>"]
 license = "MIT"
@@ -18,6 +18,7 @@ python = "^3.10"
 click = ">=8.0.1"
 pandas = "^2.2.0"
 pendulum = "^3.0.0"
+dapla-toolbelt = "^2.0.19"
 
 [tool.poetry.group.dev.dependencies]
 pygments = ">=2.10.0"

src/ssb_konjunk/timestamp.py

@@ -1,7 +1,7 @@
 """Functions to create timestamp according to SSB standard."""
 
 
-def check_even(elements: list[int]) -> bool:
+def _check_even(elements: list[int]) -> bool:
     """Function to check if number is even."""
     return len(elements) % 2 == 0
 
@@ -158,7 +158,7 @@ def _check_frequency_suport(frequency: str) -> None:
         )
 
 
-def get_timestamp_daily(*args: int) -> str | None:
+def _get_timestamp_daily(*args: int) -> str | None:
     """Function to create timestamp if frequency is daily."""
     if len(args) == 3:
         _check_valid_year(args[0])
@@ -178,7 +178,7 @@ def get_timestamp_daily(*args: int) -> str | None:
         raise ValueError(f"Ikke gyldig mende args, du har antall:{len(args)}")
 
 
-def get_timestamp_yearly(*args: int) -> str | None:
+def _get_timestamp_yearly(*args: int) -> str | None:
     """Function to create timstamp if frequency is yearly."""
     if len(args) == 2:
         _check_valid_year(args[0], args[1])
@@ -189,16 +189,8 @@ def get_timestamp_yearly(*args: int) -> str | None:
         )
 
 
-def get_timestamp_special(*args: int, frequency: str) -> str | None:
-    """Function to create timestamp if frequency is now Y or D.
-
-    Args:
-        args: Up to six arguments with int, to create timestamp for.
-        frequency: Letter for which frequency the data is, Y for year etc.
-
-    Returns:
-        string|None: Returns time stamp in ssb format.
-    """
+def _get_timestamp_special(*args: int, frequency: str) -> str | None:
+    """Function to create timestamp if frequency is not Y or D."""
     _check_valid_args(*args, frequency=frequency)
 
     if frequency in ["M", "W"]:
@@ -222,7 +214,7 @@ def get_timestamp_special(*args: int, frequency: str) -> str | None:
 
 
 def get_ssb_timestamp(*args: int, frequency: str = "M") -> str | None:
-    """Function to create a string in ssb timestamp format.
+    r"""Function to create a string in ssb timestamp format.
 
     Args:
         args: Up to six arguments with int, to create timestamp for.
@@ -233,6 +225,10 @@ def get_ssb_timestamp(*args: int, frequency: str = "M") -> str | None:
 
     Raises:
         ValueError: Raises error for wrong values in args.
+
+    Example:
+        >>> get_ssb_timestamp(2024,8,1, frequency='D')
+        'p2024-08-01'
     """
     _check_frequency_suport(frequency)
 
@@ -254,16 +250,16 @@ def get_ssb_timestamp(*args: int, frequency: str = "M") -> str | None:
         valid_args = [arg for arg in args if arg]
 
         if frequency == "D":
-            return get_timestamp_daily(*valid_args)
+            return _get_timestamp_daily(*valid_args)
 
-        if not check_even(valid_args) or len(valid_args) > 4:
+        if not _check_even(valid_args) or len(valid_args) > 4:
             print(
                 f"For frekvens '{frequency}', må du ha enten to eller fire argumenter. Du har:",
                 len(valid_args),
             )
             return None
         else:
             if frequency == "Y":
-                return get_timestamp_yearly(*valid_args)
+                return _get_timestamp_yearly(*valid_args)
             else:
-                return get_timestamp_special(*valid_args, frequency=frequency)
+                return _get_timestamp_special(*valid_args, frequency=frequency)

src/ssb_konjunk/xml_handling.py

@@ -5,7 +5,7 @@
 import dapla
 
 
-def read_xml(xml_file: str, fs: dapla.gcs.GCSFileSystem = None) -> ET.Element:
+def read_xml(xml_file: str, fs: dapla.gcs.GCSFileSystem | None = None) -> ET.Element:
     """Funtion to get xml root from disk.
 
     Args:

tests/test_timestamp.py

@@ -2,6 +2,7 @@
 
 import pytest
 
+from ssb_konjunk.timestamp import _check_even
 from ssb_konjunk.timestamp import _check_valid_day
 from ssb_konjunk.timestamp import _check_valid_half_year
 from ssb_konjunk.timestamp import _check_valid_month
@@ -10,41 +11,42 @@
 from ssb_konjunk.timestamp import _check_valid_trimester
 from ssb_konjunk.timestamp import _check_valid_week
 from ssb_konjunk.timestamp import _check_valid_year
-from ssb_konjunk.timestamp import check_even
+from ssb_konjunk.timestamp import _get_timestamp_daily
+from ssb_konjunk.timestamp import _get_timestamp_special
+from ssb_konjunk.timestamp import _get_timestamp_yearly
 from ssb_konjunk.timestamp import get_ssb_timestamp
-from ssb_konjunk.timestamp import get_timestamp_daily
-from ssb_konjunk.timestamp import get_timestamp_special
-from ssb_konjunk.timestamp import get_timestamp_yearly
 
 
 def test_check_even() -> None:
-    """Test of function check_even."""
+    """Test of function _check_even."""
     # Testing True
-    assert check_even([2, 1]) is True
+    assert _check_even([2, 1]) is True
     # Testing False
-    assert check_even([3, 2, 1]) is False
+    assert _check_even([3, 2, 1]) is False
 
 
 def test_get_timestamp_daily() -> None:
-    """Test of function get_timestamp_daily."""
+    """Test of function _get_timestamp_daily."""
     # Testing True
-    assert get_timestamp_daily(2020, 1, 1, 2020, 1, 31) == "p2020-01-01_p2020-01-31"
+    assert _get_timestamp_daily(2020, 1, 1, 2020, 1, 31) == "p2020-01-01_p2020-01-31"
 
 
 def test_get_timestamp_yearly() -> None:
-    """Test of function get_timestamp_yearly."""
+    """Test of function _get_timestamp_yearly."""
     # Testing True
-    assert get_timestamp_yearly(2020, 2021) == "p2020_p2021"
+    assert _get_timestamp_yearly(2020, 2021) == "p2020_p2021"
 
 
 def test_test_get_timestamp_special() -> None:
-    """Test of function get_timestamp_special."""
+    """Test of function _get_timestamp_special."""
     # Testing month
-    assert get_timestamp_special(2020, 1, 2021, 2, frequency="M") == "p2020-01_p2021-02"
+    assert (
+        _get_timestamp_special(2020, 1, 2021, 2, frequency="M") == "p2020-01_p2021-02"
+    )
     # Testing quarter
-    assert get_timestamp_special(2020, 1, 2021, 2, frequency="Q") == "p2020Q1_p2021Q2"
+    assert _get_timestamp_special(2020, 1, 2021, 2, frequency="Q") == "p2020Q1_p2021Q2"
     # Testing term
-    assert get_timestamp_special(2020, 1, 2021, 2, frequency="B") == "p2020B1_p2021B2"
+    assert _get_timestamp_special(2020, 1, 2021, 2, frequency="B") == "p2020B1_p2021B2"
 
 
 def test_get_ssb_timestamp() -> None: