compass-lib 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

compass_lib/validation.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+"""Validation utilities for Compass data.
+
+This module provides validation functions for station names and other
+data elements based on Compass format specifications.
+"""
+
+import calendar
+import re
+from re import Pattern
+
+# Station name pattern: printable ASCII characters (0x21-0x7F), no spaces
+# The original Compass spec limited to 12 chars, but modern files often exceed this
+# We allow any length but still require valid printable ASCII
+STATION_NAME_PATTERN: Pattern[str] = re.compile(r"^[\x21-\x7f]+$")
+
+
+def is_valid_station_name(name: str) -> bool:
+    """Check if a station name is valid.
+
+    Valid station names:
+    - 1 or more characters (no upper limit enforced)
+    - Printable ASCII only (0x21-0x7F)
+    - No spaces or control characters
+
+    Note: The original Compass format limited station names to 12 characters,
+    but many modern Compass files use longer names. This validation accepts
+    any length to ensure compatibility with real-world data.
+
+    Args:
+        name: Station name to validate
+
+    Returns:
+        True if valid, False otherwise
+    """
+    if not name:
+        return False
+    return bool(STATION_NAME_PATTERN.match(name))
+
+
+def validate_station_name(name: str) -> None:
+    """Validate a station name, raising an error if invalid.
+
+    Args:
+        name: Station name to validate
+
+    Raises:
+        ValueError: If the station name is invalid
+    """
+    if not is_valid_station_name(name):
+        # Escape non-printable characters for error message
+        escaped = ""
+        for char in name:
+            if ord(char) < 0x20 or ord(char) > 0x7F:
+                escaped += f"\\x{ord(char):02x}"
+            else:
+                escaped += char
+        msg = f"Invalid station name: {escaped}"
+        raise ValueError(msg)
+
+
+def days_in_month(month: int, year: int) -> int:
+    """Get the number of days in a month, accounting for leap years.
+
+    Args:
+        month: Month (1-12)
+        year: Year
+
+    Returns:
+        Number of days in the month
+    """
+    # monthrange returns (weekday_of_first_day, num_days_in_month)
+    _, num_days = calendar.monthrange(year, month)
+    return num_days

compass_lib-0.0.3.dist-info/METADATA

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: compass_lib
+Version: 0.0.3
+Summary: Compass Parser Library.
+Keywords: cave,survey,karst
+Author-email: Jonathan Dekhtiar <jonathan@dekhtiar.com>
+Maintainer-email: Jonathan Dekhtiar <jonathan@dekhtiar.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+License-File: LICENSE
+Requires-Dist: geojson>=3.2,<4
+Requires-Dist: orjson>=3.10,<3.12
+Requires-Dist: pydantic>=2.12,<2.13
+Requires-Dist: pydantic-extra-types>=2.11,<3.0
+Requires-Dist: pyIGRF14==1.0.4
+Requires-Dist: pyproj>=3.7.1,<3.8
+Requires-Dist: utm>=0.8.1,<0.9
+Requires-Dist: cryptography>=44.0.0,<47.0.0 ; extra == "test"
+Requires-Dist: python-dotenv>=1.0.0,<2.0.0 ; extra == "test"
+Requires-Dist: deepdiff>=7.0,<9.0 ; extra == "test"
+Requires-Dist: pytest>=8.0.0,<10.0.0 ; extra == "test"
+Requires-Dist: pytest-cov>=5.0.0,<8.0.0 ; extra == "test"
+Requires-Dist: pytest-dotenv>=0.5.0,<1.0.0 ; extra == "test"
+Requires-Dist: pytest-env>=1.1.3,<2.0.0 ; extra == "test"
+Requires-Dist: pytest-runner>=6.0.0,<7.0.0 ; extra == "test"
+Requires-Dist: pytest-ordering>=0.6,<1.0.0 ; extra == "test"
+Requires-Dist: parameterized>=0.9.0,<0.10 ; extra == "test"
+Project-URL: Bug Reports, https://github.com/OpenSpeleo/pytool_compass_lib/issues
+Project-URL: Homepage, https://pypi.org/project/compass-lib/
+Project-URL: Source, https://github.com/OpenSpeleo/pytool_compass_lib
+Provides-Extra: test
+
+# Compass Python Lib
+
+## Conversion commands:
+
+```bash
+# Install in dev mod
+pip install -e ".[dev,test]"
+
+# Install latest stable version
+pip install compass_lib
+
+# run some commands
+compass convert --input_file=./tests/artifacts/fulford.dat  --output_file=fulford.json --format=json --overwrite
+compass convert --input_file=./tests/artifacts/random.dat  --output_file=random.json --format=json --overwrite
+```
+

compass_lib-0.0.3.dist-info/RECORD

@@ -0,0 +1,31 @@
+compass_lib/__init__.py,sha256=GmS4B4rae0P8zy4-givpmeyFUSqKRJ8WEERgxro9Gxs,3594
+compass_lib/constants.py,sha256=TApFKLFXywSS_iFx_UBBO9mQhjW2-1f8Wsu0J-Mr-rU,3144
+compass_lib/enums.py,sha256=PgIOhqb6qUBHZhZpVaZfQ_qG6DCp2nfQD4SghM-lAoM,9667
+compass_lib/errors.py,sha256=0D5jCIroPdRX2oVx1PK_lotYKDdjc_94jeFKQhW8pBE,2473
+compass_lib/geo_utils.py,sha256=5KKHKNIGOXrV3dTGbaLbGY4j7EajFXf0bcKFsDyJ0Sg,1409
+compass_lib/geojson.py,sha256=yROsA_J19Afkx-_i3E2TFL2Qi28uAhhAfjLWmpzDoFA,34289
+compass_lib/interface.py,sha256=GcM2yRD39dpy94brTIpJD-Z5DSlmBjpuu6dkTsHpyoI,10576
+compass_lib/io.py,sha256=xU8JYg0gQK6FrpvEQHqXHCBotIWNVJP2Iu1MidgBbQ8,6506
+compass_lib/models.py,sha256=vXQ-kJZVFRmUsNV3-8bsdTC48hLmkuoOIsIco8_al9Y,7036
+compass_lib/validation.py,sha256=tfLn3MNblpQ7vb0TDeimEQV_zeNkLMT8NY0xCdUQFOo,2176
+compass_lib/commands/__init__.py,sha256=kHsx7hB3ivV6wfdRn1KkhlbVPkLcaGsMLXOdgZhKU3Q,79
+compass_lib/commands/convert.py,sha256=RZ3ZFd83yAb2pgso6oaRRtHjEHMSojsaoKmo4RX6fcs,8501
+compass_lib/commands/encrypt.py,sha256=dD5IspbWPnjFjiFDa5RBkfgrQzG_5VglPKGqIOk_Uf8,3189
+compass_lib/commands/geojson.py,sha256=kRgukxnGJIFvFod9odJFaMBZE6BK0I3polNZyBx9G9s,3554
+compass_lib/commands/main.py,sha256=rce8oDfTwZdR5oKVQggNeGn8geIldPRbjvqRucwnFAI,775
+compass_lib/plot/__init__.py,sha256=YXIKLAJSmHtIxiZNxCkDJLR3ud8Dgeea7pKrchB_NtY,953
+compass_lib/plot/models.py,sha256=OEbSibClG95Jo-rDET2chAcfuE0qLsfnj522WW3jmtY,7815
+compass_lib/plot/parser.py,sha256=K3YK-CVXCxAUhLQpi95CajPvWCWOwv41d05Whylysxg,19294
+compass_lib/project/__init__.py,sha256=qdYdBCdEP669a4zT3r7xHm6qDGquf52hkeMyKzXMx_c,1312
+compass_lib/project/format.py,sha256=uxSNG97yzwfUZpV7uYS8n6q0cZEzfSuKi8igBhZwKGY,5033
+compass_lib/project/models.py,sha256=Z3qDggeEV_SEoO5ky5Wjrc7ZmyNdxnTSolNSIpoyQb0,15033
+compass_lib/project/parser.py,sha256=YV3_qUMNbd_enql_5BKcU8jithltTzSmdhbgpSBNvIU,21733
+compass_lib/survey/__init__.py,sha256=9BfBbW0luUr1ldNI4joD1WuZpTH7wuQ2lsdyMw-ppYY,784
+compass_lib/survey/format.py,sha256=L5DPPe3riTknro2a_V70n-jkdJOkp9wK6TX0KbMjrPM,8655
+compass_lib/survey/models.py,sha256=YRch52D0kBf9SxQ5RIhbvIy09-Yt2AtNeNRugJd7K_c,5258
+compass_lib/survey/parser.py,sha256=xvBi3jr1Hgq3rzRzWTYJFQaAHpv7jFtD-QBeyhmAjhM,27402
+compass_lib-0.0.3.dist-info/entry_points.txt,sha256=VhEdfsIVxwPerPEyPYms1IIJ6r4UOeCgPagV2BMzUd8,216
+compass_lib-0.0.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+compass_lib-0.0.3.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+compass_lib-0.0.3.dist-info/METADATA,sha256=9oGhJp4nt62bUfzsDLYJgujs7c-kVELSR7Nc1k1kEv8,2393
+compass_lib-0.0.3.dist-info/RECORD,,

{compass_lib-0.0.1.dist-info → compass_lib-0.0.3.dist-info}/WHEEL

@@ -1,6 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.1.1)
+Generator: flit 3.12.0
 Root-Is-Purelib: true
-Tag: py2-none-any
 Tag: py3-none-any
-

compass_lib-0.0.3.dist-info/entry_points.txt

@@ -0,0 +1,8 @@
+[compass_lib.actions]
+convert=compass_lib.commands.convert:convert
+encrypt=compass_lib.commands.encrypt:encrypt
+geojson=compass_lib.commands.geojson:geojson
+
+[console_scripts]
+compass=compass_lib.commands.main:main
+

compass_lib/parser.py

@@ -1,282 +0,0 @@
-#!/usr/bin/env python
-
-import re
-import datetime
-import hashlib
-import json
-from typing import Optional, Union
-
-from pathlib import Path
-from compass_lib.enums import ShotFlag
-
-from compass_lib.section import SurveySection
-from compass_lib.shot import SurveyShot
-
-from functools import cached_property
-
-
-import dataclasses
-from dataclasses import dataclass
-
-# ============================== CompassFileFormat ============================== #
-
-#   _formatFormat(): string {
-#     const {
-#       displayAzimuthUnit,
-#       displayLengthUnit,
-#       displayLrudUnit,
-#       displayInclinationUnit,
-#       lrudOrder,
-#       shotMeasurementOrder,
-#       hasBacksights,
-#       lrudAssociation,
-#     } = this
-#     return `${inverseAzimuthUnits[displayAzimuthUnit]}${
-#       inverseLengthUnits[displayLengthUnit]
-#     }${inverseLengthUnits[displayLrudUnit]}${
-#       inverseInclinationUnits[displayInclinationUnit]
-#     }${lrudOrder
-#       .map(i => inverseLrudItems[i])
-#       .join('')}${shotMeasurementOrder
-#       .map(i => inverseShotMeasurementItems[i])
-#       .join('')}${hasBacksights ? 'B' : 'N'}${
-#       lrudAssociation != null ? inverseStationSides[lrudAssociation] : ''
-#     }`
-#   }
-
-@dataclass
-class CompassFileFormat:
-    displayAzimuthUnit: str
-    displayLengthUnit: str
-    displayLrudUnit: str
-    displayInclinationUnit: str
-    lrudOrder: str
-    shotMeasurementOrder: str
-    hasBacksights: str
-    lrudAssociation: str
-
-    @classmethod
-    def from_str(cls, input):
-        return cls(
-            displayAzimuthUnit="",
-            displayLengthUnit="",
-            displayLrudUnit="",
-            displayInclinationUnit="",
-            lrudOrder="",
-            shotMeasurementOrder="",
-            hasBacksights="",
-            lrudAssociation="",
-        )
-
-
-
-class EnhancedJSONEncoder(json.JSONEncoder):
-    def default(self, obj):
-
-        if dataclasses.is_dataclass(obj):
-            return dataclasses.asdict(obj)
-
-        if isinstance(obj, datetime.date):
-            return obj.isoformat()
-
-        if isinstance(obj, ShotFlag):
-            return obj.value
-
-        return super().default(obj)
-
-
-class CompassParser:
-    SEPARATOR = "\f"  # Form_feed: https://www.ascii-code.com/12
-    END_OF_FILE = "\x1A"  # Substitute: https://www.ascii-code.com/26
-
-    def __init__(self, filepath: str) -> None:
-
-        self._filepath = Path(filepath)
-
-        if not self.filepath.is_file():
-            raise FileNotFoundError(f"File not found: {filepath}")
-
-        # Ensure at least that the file type is valid
-        _ = self._data
-
-    # =================== Data Loading =================== #
-
-    @cached_property
-    def _data(self):
-
-        with self.filepath.open(mode="r") as f:
-            data = f.read()
-
-        return [
-            activity.strip()
-            for activity in data.split(CompassParser.SEPARATOR)
-            if CompassParser.END_OF_FILE not in activity
-        ]
-
-    # =================== File Properties =================== #
-
-    def __repr__(self) -> str:
-        repr = f"[CompassSurveyFile {self.filetype.upper()}] `{self.filepath}`:"
-        # for key in self._KEY_MAP.keys():
-        #     if key.startswith("_"):
-        #         continue
-        #     repr += f"\n\t- {key}: {getattr(self, key)}"
-        # repr += f"\n\t- shots: Total Shots: {len(self.shots)}"
-        # repr += f"\n\t- hash: {self.hash}"
-        return repr
-
-    @cached_property
-    def __hash__(self):
-        # return hashlib.sha256(self._as_binary()).hexdigest()
-        return hashlib.sha256("0".encode()).hexdigest()
-
-    @property
-    def hash(self):
-        return self.__hash__
-
-    # =============== Descriptive Properties =============== #
-
-    @property
-    def filepath(self):
-        return self._filepath
-
-    @property
-    def filetype(self):
-        return self.filepath.suffix[1:]
-        # try:
-        #     return ArianeFileType.from_str(self.filepath.suffix[1:])
-        # except ValueError as e:
-        #     raise TypeError(e) from e
-
-    @property
-    def lstat(self):
-        return self.filepath.lstat()
-
-    @property
-    def date_created(self):
-        return self.lstat.st_ctime
-
-    @property
-    def date_last_modified(self):
-        return self.lstat.st_mtime
-
-    @property
-    def date_last_opened(self):
-        return self.lstat.st_atime
-
-    # =================== Data  Processing =================== #
-
-    @cached_property
-    def data(self):
-        sections = []
-        for activity in self._data:
-            entries = activity.splitlines()
-
-            cave_name = entries[0].strip()
-
-            if "SURVEY NAME: " not in entries[1]:
-                raise RuntimeError
-            survey_name = entries[1].split(":")[-1].strip()
-
-            date_str, comment_str = entries[2].split("  ", maxsplit=1)
-
-            if "SURVEY DATE: " not in date_str:
-                raise RuntimeError
-            date = date_str.split(":")[-1].strip()
-
-            if "COMMENT:" not in comment_str:
-                raise RuntimeError
-            survey_comment = comment_str.split(":")[-1].strip()
-
-            if "SURVEY TEAM:" != entries[3].strip():
-                raise RuntimeError
-
-            surveyors = [suveyor.strip() for suveyor in entries[4].split(",") if suveyor.strip() != ""]
-
-            if "DECLINATION:" not in entries[5]:
-                raise RuntimeError
-            if "FORMAT:" not in entries[5]:
-                raise RuntimeError
-            if "CORRECTIONS:" not in entries[5]:
-                raise RuntimeError
-
-            _, declination_str, _, format_str, _, correct_A, correct_B, correct_C = entries[5].split()
-
-            shots = list()
-            for shot in entries[9:]:
-                shot_data = shot.split(maxsplit=9)
-                from_id, to_id, length, bearing, incl, left, up, down, right = shot_data[:9]
-
-                try:
-                    flags_comment = shot_data[9]
-
-                    flag_regex = rf"({ShotFlag.__start_token__}([{''.join(ShotFlag._value2member_map_.keys())}]*){ShotFlag.__end_token__})*(.*)"
-                    _, flag_str, comment = re.search(flag_regex, flags_comment).groups()
-
-                    flags = [ShotFlag._value2member_map_[f] for f in flag_str] if flag_str else None
-
-                except IndexError:
-                    flags = None
-                    comment = None
-
-                shots.append(SurveyShot(
-                    from_id=from_id,
-                    to_id=to_id,
-                    length=float(length),
-                    bearing=float(bearing),
-                    inclination=float(incl),
-                    left=float(left),
-                    up=float(up),
-                    down=float(down),
-                    right=float(right),
-                    flags=sorted(set(flags), key=lambda f: f.value) if flags else None,
-                    comment=comment.strip() if comment else None
-                ))
-
-            section = SurveySection(
-                cave_name=cave_name,
-                survey_name=survey_name,
-                date=datetime.datetime.strptime(date, "%m %d %Y").date(),
-                comment=survey_comment,
-                surveyors=surveyors,
-                declination=float(declination_str),
-                format=format_str,
-                correction=(float(correct_A), float(correct_B), float(correct_C)),
-                shots=shots
-            )
-            sections.append(section)
-
-        return sections
-
-
-    # =================== Export Formats =================== #
-
-    def to_json(self, filepath: Optional[Union[str, Path]] = None) -> str:
-        json_str = json.dumps(self.data, indent=4, sort_keys=True, cls=EnhancedJSONEncoder)
-
-        if filepath is not None:
-            with open(filepath, mode="w") as file:
-                file.write(json_str)
-
-        return json_str
-
-    # ==================== Public APIs ====================== #
-
-    @cached_property
-    def shots(self):
-        return []
-        # return [
-        #     SurveyShot(data=survey_shot)
-        #     for survey_shot in self._KEY_MAP.fetch(self._shots_list, "_shots")
-        # ]
-
-    @cached_property
-    def sections(self):
-        return []
-        # section_map = dict()
-        # for shot in self.shots:
-        #     try:
-        #         section_map[shot.section].add_shot(shot)
-        #     except KeyError:
-        #         section_map[shot.section] = SurveySection(shot=shot)
-        # return list(section_map.values())

compass_lib/section.py

@@ -1,18 +0,0 @@
-#!/usr/bin/env python
-
-from datetime import date
-from dataclasses import dataclass
-from compass_lib.shot import SurveyShot
-
-
-@dataclass
-class SurveySection:
-    cave_name: str
-    survey_name: str
-    date: date
-    comment: str
-    surveyors: list[str]
-    declination: float
-    format: str
-    correction: tuple[float, float, float]
-    shots: list[SurveyShot]

compass_lib/shot.py

@@ -1,21 +0,0 @@
-#!/usr/bin/env python
-
-from dataclasses import dataclass
-
-from compass_lib.enums import ShotFlag
-
-@dataclass
-class SurveyShot:
-    #         FROM           TO   LENGTH  BEARING      INC     LEFT       UP     DOWN    RIGHT   FLAGS  COMMENTS
-    #           A1           A2    21.75    63.50   -28.00     2.60     2.60     2.60     2.60#
-    from_id: str
-    to_id: str
-    length: float
-    bearing: float
-    inclination: float
-    left: float
-    up: float
-    down: float
-    right: float
-    flags: list[ShotFlag]
-    comment: str