ft3 0.0.1__py3-none-any.whl

ft3/__init__.py

@@ -0,0 +1,56 @@
+"""
+Overview
+========
+
+**Author:** dan@1howardcapital.com
+
+**Summary:** Zero-dependency python framework for object oriented development.
+Implement _once_, document _once_, in _one_ place.
+
+---
+
+With ft3, you will quickly learn established best practice... \
+or face the consequences of runtime errors that will break your code \
+if you deviate from it.
+
+Experienced python engineers will find a framework \
+that expects and rewards intuitive magic method implementations, \
+consistent type annotations, and robust docstrings.
+
+Implement _pythonically_ with ft3 and you will only ever need to: \
+implement _once_, document _once_, in _one_ place.
+
+---
+
+Getting Started
+---------------
+
+### Installation
+
+Install from command line, with pip:
+
+`$ pip install ft3`
+
+"""
+
+__all__ = (
+    'cli',
+    'core',
+    'docs',
+    'log',
+    'loggers',
+    'objects',
+    'Field',
+    'Object'
+    )
+
+__version__ = '0.0.1'
+
+from . import cli
+from . import core
+from . import docs
+from . import loggers
+from . import objects
+
+from . loggers import log
+from . objects import Field, Object

ft3/cli/__init__.py

@@ -0,0 +1,31 @@
+"""
+Overview
+========
+
+**Summary:** Primary command-line interface (CLI) to ft3.
+
+---
+
+Usage
+-----
+
+```sh
+$ ft3 --help
+```
+
+"""
+
+__all__ = (
+    'cfg',
+    'lib',
+    'obj',
+    'main',
+    'utl',
+    )
+
+from . import cfg
+from . import lib
+from . import obj
+from . import utl
+
+from . utl import main

ft3/cli/cfg.py

@@ -0,0 +1,11 @@
+"""CLI constants."""
+
+__all__ = (
+    'Constants',
+    )
+
+from .. import core
+
+
+class Constants(core.cfg.Constants):
+    """Constant values specific to CLI modules."""

ft3/cli/lib.py

@@ -0,0 +1,7 @@
+"""CLI imports."""
+
+from .. import core
+
+__all__ = core.lib.__all__
+
+from .. core . lib import *

ft3/cli/obj.py

@@ -0,0 +1,34 @@
+"""CLI objects."""
+
+__all__ = (
+    'parsers',
+    'root_parser',
+    )
+
+from .. import __version__
+
+from . import cfg
+from . import lib
+
+
+class Constants(cfg.Constants):
+    """Constant values specific to CLI objs."""
+
+
+root_parser = lib.argparse.ArgumentParser(
+    description='root_parser',
+    formatter_class=lib.argparse.ArgumentDefaultsHelpFormatter,
+    prog='ft3',
+    )
+root_parser.add_argument(
+    '--version',
+    '-v',
+    action='version',
+    version=__version__,
+    )
+
+parsers = root_parser.add_subparsers(
+    title='module',
+    required=True,
+    help='specify a module to access its commands'
+    )

ft3/cli/utl.py

@@ -0,0 +1,25 @@
+"""CLI utility functions."""
+
+__all__ = (
+    'main',
+    )
+
+from . import obj
+
+
+def main() -> None:  # pragma: no cover
+    """
+    Main CLI entrypoint.
+
+    Commands follow the structure:
+
+    `$ ft3 {fgr_module_name} ...`
+
+    """
+
+    args = obj.root_parser.parse_args()
+    kwargs = args._get_kwargs()
+    as_args = [v for k, v in kwargs if k != 'func']
+    args.func(*as_args)  # type: ignore[attr-defined]
+
+    return None

ft3/core/__init__.py

@@ -0,0 +1,37 @@
+"""
+Overview
+========
+
+**Author:** dan@1howardcapital.com
+
+**Summary:** Zero-dependency python framework for object oriented development.
+
+---
+
+Usage
+-----
+
+```py
+import ft3
+
+```
+
+"""
+
+__all__ = (
+    'cfg',
+    'codecs',
+    'enm',
+    'exc',
+    'lib',
+    'strings',
+    'typ',
+    )
+
+from . import cfg
+from . import codecs
+from . import enm
+from . import exc
+from . import lib
+from . import strings
+from . import typ

ft3/core/cfg.py

@@ -0,0 +1,67 @@
+"""Core constants."""
+
+__all__ = (
+    'Constants',
+    )
+
+from . import lib
+
+if lib.t.TYPE_CHECKING:  # pragma: no cover
+    from . import typ
+
+
+class Constants:
+    """Constant values shared across all of ft3."""
+
+    PACAKGE = 'ft3'
+    """Reference to package name."""
+
+    CLASS_AS_DICT: 'typ.string[typ.snake_case]' = 'class_as_dict'
+    """Common string reference."""
+
+    DELIM = '-'
+    """Common delimiter used throughout package."""
+
+    INDENT = int(lib.os.getenv('INDENT', 2))
+    """
+    Default, package-wide indentation.
+
+    ---
+
+    Used for `__repr__`, log messages, etc.
+
+    """
+
+    UNDEFINED = f'[[{PACAKGE.upper()}_DEFAULT_PLACEHOLDER]]'
+    """Placeholder for undefined values that should not be `None`."""
+
+    ENV = lib.os.getenv('ENV', 'local').lower()
+    """The lowered name of our runtime environment."""
+
+    DEPLOY_ENVS = (
+        'dev',
+        'develop',
+        'qa',
+        'test',
+        'testing',
+        'stg',
+        'stage',
+        'staging',
+        'uat',
+        'prod',
+        'production',
+        )
+    """Valid, non-local runtime environment names."""
+
+    DELIM_REBASE = '_X_'
+
+    __ANNOTATIONS__: 'typ.string[typ.snake_case]' = '__annotations__'
+    __DATACLASS_FIELDS__: 'typ.string[typ.snake_case]' = '__dataclass_fields__'
+    __DICT__: 'typ.string[typ.snake_case]' = '__dict__'
+    __HERITAGE__: 'typ.string[typ.snake_case]' = '__heritage__'
+    __SLOTS__: 'typ.string[typ.snake_case]' = '__slots__'
+    __MODULE__: 'typ.string[typ.snake_case]' = '__module__'
+
+    FIELDS: 'typ.string[typ.snake_case]' = 'fields'
+    ENUMERATIONS: 'typ.string[typ.snake_case]' = 'enumerations'
+    HASH_FIELDS: 'typ.string[typ.snake_case]' = 'hash_fields'

ft3/core/codecs/__init__.py

@@ -0,0 +1,15 @@
+"""Core codec modules."""
+
+__all__ = (
+    'cfg',
+    'enm',
+    'lib',
+    'typ',
+    'utl',
+    )
+
+from . import cfg
+from . import enm
+from . import lib
+from . import typ
+from . import utl

ft3/core/codecs/cfg.py

@@ -0,0 +1,46 @@
+"""Codec constants."""
+
+__all__ = (
+    'Constants',
+    )
+
+from .. import cfg
+
+from . import lib
+from . import typ
+
+
+def _isoformat_encoder(
+    o: lib.datetime.datetime | lib.datetime.date | lib.datetime.time
+    ) -> str:
+    return o.isoformat()
+
+
+class Constants(cfg.Constants):
+    """Constant values shared across core codecs modules."""
+
+    ENCODERS: dict[
+        type[lib.t.Any],
+        lib.t.Callable[[lib.t.Any], typ.Serial]
+        ] = {
+            bytes: lambda o: getattr(o, 'decode')(),
+            lib.datetime.date: _isoformat_encoder,
+            lib.datetime.datetime: _isoformat_encoder,
+            lib.datetime.time: _isoformat_encoder,
+            lib.datetime.timedelta: lambda td: getattr(td, 'total_seconds')(),
+            lib.decimal.Decimal: float,
+            lib.enum.Enum: lambda o: getattr(o, 'value'),
+            frozenset: list,
+            lib.collections.deque: list,
+            lib.types.GeneratorType: list,
+            lib.ipaddress.IPv4Address: str,
+            lib.ipaddress.IPv4Interface: str,
+            lib.ipaddress.IPv4Network: str,
+            lib.ipaddress.IPv6Address: str,
+            lib.ipaddress.IPv6Interface: str,
+            lib.ipaddress.IPv6Network: str,
+            lib.pathlib.Path: str,
+            lib.re.Pattern: lambda o: getattr(o, 'pattern'),
+            set: list,
+            lib.uuid.UUID: str,
+            }

ft3/core/codecs/enm.py

@@ -0,0 +1,65 @@
+"""Codecs enumerations."""
+
+from .. import enm
+
+__all__ = (
+    'ParseErrorRef',
+    *enm.__all__
+    )
+
+from .. enm import *
+
+from . import lib
+from . import typ
+
+
+class ParseErrorRef(lib.enum.Enum):
+    """
+    Valid ErrorRef Enumeration.
+
+    """
+
+    bool_decode           = typ.ErrorRef(
+        'Could not decode valid JSON string to python `bool`.'
+        )
+    invalid_arr_decode    = typ.ErrorRef(
+        'Could not decode valid JSON array to python: `invalid item type(s)`.'
+        )
+    invalid_arr_len       = typ.ErrorRef(
+        'Could not decode valid JSON array to python: `invalid array length`.'
+        )
+    invalid_json          = typ.ErrorRef(
+        'Could not deserialize string as valid JSON.'
+        )
+    invalid_keys_decode   = typ.ErrorRef(
+        'Could not decode valid JSON object to python: `invalid keys`.'
+        )
+    invalid_map_decode    = typ.ErrorRef(
+        ' '.join(
+            (
+                'Could not decode valid JSON object to python:',
+                '`invalid item type(s)`.'
+                )
+            )
+        )
+    invalid_values_decode = typ.ErrorRef(
+        'Could not decode valid JSON object to python: `invalid values`.'
+        )
+    number_decode         = typ.ErrorRef(
+        ' '.join(
+            (
+                'Could not decode valid JSON string to python',
+                '`numbers.Number`.'
+                )
+            )
+        )
+    null_decode           = typ.ErrorRef(
+        'Could not decode valid JSON string to python `None`.'
+        )
+    datetime_decode       = typ.ErrorRef(
+        'Could not decode value to valid `datetime`.'
+        )
+    literal_decode        = typ.ErrorRef(
+        'Could not decode value to valid `Literal`.'
+        )
+    value_decode          = typ.ErrorRef('Could not decode invalid value.')

ft3/core/codecs/lib.py

@@ -0,0 +1,20 @@
+"""Codecs imports."""
+
+from .. import lib
+
+__all__ = (
+    'collections',
+    'ipaddress',
+    'numbers',
+    'pathlib',
+    'uuid',
+    *lib.__all__
+    )
+
+import collections.abc
+import ipaddress
+import numbers
+import pathlib
+import uuid
+
+from .. lib import *

ft3/core/codecs/typ.py

@@ -0,0 +1,14 @@
+"""Codecs types."""
+
+from .. import typ
+
+__all__ = (
+    'ErrorRef',
+    *typ.__all__
+    )
+
+from .. typ import *
+
+from . import lib
+
+ErrorRef = lib.t.NewType('ErrorRef', str)