half-orm-dev 0.16.0a9__py3-none-any.whl

half_orm_dev/templates/.gitignore

@@ -0,0 +1,15 @@
+*~
+*.pyc
+\#*
+.#*
+*.swp
+tmp
+build
+dist
+*.egg-info
+.vscode
+.noseids
+.pdbrc
+Backups
+__pycache__
+.hop/alt_config

half_orm_dev/templates/MANIFEST.in

@@ -0,0 +1 @@
+global-exclude *_test.py

half_orm_dev/templates/Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+half-orm = "{half_orm_version}"
+
+[dev-packages]
+pytest = "*"
+build = "*"
+twine = "*"
+tox = "*"

half_orm_dev/templates/README

@@ -0,0 +1,25 @@
+# halfORM package `{package_name}` for the `{dbname}` database.
+
+This package has been generated by [hop](https://github.com/collorg/halfORM/blob/main/doc/hop.md) version {hop_version}.
+
+Use the `hop` command in this directory of any subdirectory to synchronise
+the modules in this package with any changes in your model.
+
+If you manually add any file to this package, make sure its name
+does not conflict with a relation name in your model.
+
+# Usage
+
+Before you can use this package you will have to:
+
+- install [half-orm](https://github.com/collorg/halfORM),
+- specify the connection parameters to the `{dbname}` database in `/etc/half_orm/{package_name}` file:
+  ```
+    [database]
+    name = {dbname}
+    user = <username>
+    password = <password>
+    host = <ip address|localhost>
+    port = <port number|5432>
+    ```
+- install the package by running `pip3 install --upgrade .` in this directory.

half_orm_dev/templates/conftest_template

@@ -0,0 +1,42 @@
+"""Common test fixtures for {package_name} package.
+
+This file provides base fixtures for database integration tests.
+Developers can add schema-specific or table-specific fixtures by creating
+conftest.py files in the appropriate subdirectories.
+
+Generated by half_orm v{hop_release}
+"""
+import pytest
+from half_orm.model import Model
+from half_orm.relation import Relation
+
+
+@pytest.fixture(scope="session")
+def database_model():
+    """
+    Provide database Model for integration tests.
+
+    Scope: session (created once per test session)
+    Returns: Model instance for {package_name} database
+
+    Example:
+        def test_query(database_model):
+            users = database_model.get_relation_class('public.users')
+            assert users is not None
+    """
+    return Model("{package_name}")
+
+
+@pytest.fixture
+def relation_class():
+    """
+    Provide Relation base class for tests.
+
+    Returns: half_orm.relation.Relation class
+
+    Example:
+        def test_inheritance(relation_class):
+            from {package_name}.public.users import Users
+            assert issubclass(Users, relation_class)
+    """
+    return Relation

half_orm_dev/templates/init_module_template

@@ -0,0 +1,10 @@
+"""This module provides the model of the database for the package {package_name}.
+"""
+from half_orm.model import Model
+from half_orm_dev.utils import resolve_database_config_name
+from pathlib import Path
+
+_package_dir = Path(__file__).parent
+_config_name = resolve_database_config_name(_package_dir)
+
+MODEL = Model(_config_name, scope=__name__)

half_orm_dev/templates/module_template_1

@@ -0,0 +1,12 @@
+# pylint: disable=wrong-import-order, invalid-name, attribute-defined-outside-init
+
+"""The module {module} provides the {class_name} class.
+
+WARNING!
+
+{warning}
+"""
+
+from half_orm.model import register
+from {package_name} import MODEL, ho_dataclasses
+fields_aliases=None

half_orm_dev/templates/module_template_2

@@ -0,0 +1,6 @@
+
+@register
+class {class_name}(MODEL.get_relation_class('{fqtn}', fields_aliases=fields_aliases), ho_dataclasses.{dc_name}):
+    """
+{documentation}
+    """

half_orm_dev/templates/module_template_3

@@ -0,0 +1,3 @@
+    #pylint: disable=line-too-long, too-many-arguments, redefined-builtin, too-many-positional-arguments
+    def __init__(self, {kwargs}):
+        super().__init__({arg_names}, **kwargs)

half_orm_dev/templates/relation_test

@@ -0,0 +1,23 @@
+"""Basic test file for the {module} module. DO NOT EDIT
+
+This test file ensures that {module}.{class_name} is instanciable and
+a subclass of half_orm.relation.Relation
+
+Fixtures are provided by tests/conftest.py
+"""
+
+from {module} import {class_name}
+
+
+def test_instanciate_relation():
+    """It should instanciate {class_name}."""
+    {class_name}()
+
+
+def test_is_relation(relation_class):
+    """
+    {class_name} should be a subclass of half_orm.Relation.
+
+    Uses relation_class fixture from tests/conftest.py
+    """
+    assert issubclass({class_name}, relation_class)

half_orm_dev/templates/setup.py

@@ -0,0 +1,81 @@
+"""Package for PostgreSQL {dbname} database.
+You can edit the following parameters:
+- version
+- author
+- author_email
+- license
+- keywords
+"""
+
+from setuptools import setup, find_packages
+from codecs import open
+from os import path
+import re
+import half_orm
+
+PWD = path.abspath(path.dirname(__file__))
+
+def get_long_description():
+    """
+    Return the README.
+    """
+    with open("README.md", encoding="utf8") as f:
+        return f.read()
+
+def get_version(package):
+    """
+    Return package version as listed in `__version__` in `init.py`.
+    """
+    with open(path.join(package, "version.txt")) as f:
+        return f.read()
+
+
+package_name='{package_name}'
+
+setup(
+    name=package_name,
+
+    version=get_version(package_name),
+
+    description='Package for {dbname} PG',
+    long_description=get_long_description(),
+    long_description_content_type='text/markdown',
+    url='',
+
+    author='',
+    author_email='',
+    license='',
+
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        'Development Status :: 3 - Alpha',
+
+        # Indicate who your project is intended for
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Build Tools',
+
+        # Pick your license as you wish (should match "license" above)
+        'License :: OSI Approved :: MIT License',
+
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+    ],
+
+    keywords='',
+
+    packages=find_packages(exclude=['contrib', 'docs', 'tests', 'patches', 'svg']),
+
+    install_requires=[
+        'half_orm=={half_orm_version}'
+    ],
+
+)

half_orm_dev/templates/sql_adapter

@@ -0,0 +1,9 @@
+from half_orm.sql_adapter import SQL_ADAPTER
+import typing
+
+__SQL_ADAPTER = {
+
+}
+
+__SQL_ADAPTER.update({f'_{key}': value for key, value in __SQL_ADAPTER.items()})
+SQL_ADAPTER = __SQL_ADAPTER

half_orm_dev/templates/warning

@@ -0,0 +1,12 @@
+This file is part of the {package_name} package. It has been generated by the
+command hop. To keep it in sync with your database structure, just rerun
+hop update.
+
+More information on the half_orm library on https://github.com/collorg/halfORM.
+
+DO NOT REMOVE OR MODIFY THE LINES BEGINING WITH:
+#>>> PLACE YOUR CODE BELOW...
+#<<< PLACE YOUR CODE ABOVE...
+
+MAKE SURE YOUR CODE GOES BETWEEN THESE LINES OR AT THE END OF THE FILE.
+hop ONLY PRESERVES THE CODE BETWEEN THESE MARKS WHEN IT IS RUN.

half_orm_dev/utils.py

@@ -0,0 +1,49 @@
+import os
+
+PWD = os.path.dirname(__file__)
+HOP_PATH = os.path.join(PWD)
+TEMPLATE_DIRS = os.path.join(HOP_PATH, 'templates')
+
+def hop_version():
+    "Returns the version of hop"
+    hop_v = None
+    with open(os.path.join(HOP_PATH, 'version.txt'), encoding='utf-8') as version:
+        hop_v = version.read().strip()
+    return hop_v
+
+def resolve_database_config_name(base_dir):
+    """
+    Resolve database configuration name with backward compatibility.
+
+    Priority:
+    1. .hop/alt_config if exists → use content
+    2. .hop/config[halfORM][package_name] if exists → use it (backward compat)
+    3. Otherwise → use directory name
+    """
+    from pathlib import Path
+    from configparser import ConfigParser
+
+    base_path = Path(base_dir)
+
+    # Priority 1: alt_config
+    alt_config_path = base_path / '.hop' / 'alt_config'
+    if alt_config_path.exists():
+        content = alt_config_path.read_text().strip()
+        if content:
+            return content
+
+    # Priority 2: package_name in .hop/config (backward compat)
+    config_path = base_path / '.hop' / 'config'
+    if config_path.exists():
+        config = ConfigParser()
+        try:
+            config.read(config_path)
+            if config.has_option('halfORM', 'package_name'):
+                package_name = config.get('halfORM', 'package_name')
+                if package_name:
+                    return package_name
+        except Exception:
+            pass
+
+    # Priority 3: directory name
+    return base_path.name

half_orm_dev/version.txt

@@ -0,0 +1 @@
+0.16.0-a9