half-orm 1.0.0rc13__tar.gz → 1.0.0rc15__tar.gz

{half_orm-1.0.0rc13 → half_orm-1.0.0rc15}/AUTHORS

@@ -1,2 +1,3 @@
 # This is the list of half_orm's significant contributors.
 # Hopefully, it will become larger...
+Joël Maizi

{half_orm-1.0.0rc13/half_orm.egg-info → half_orm-1.0.0rc15}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: half_orm
-Version: 1.0.0rc13
+Version: 1.0.0rc15
 Summary: A database-first ORM for PostgreSQL
 Author-email: Joël Maïzi <joel.maizi@collorg.org>
 License: GPL-3.0
@@ -25,6 +25,7 @@ License-File: AUTHORS
 Requires-Dist: psycopg[binary]
 Requires-Dist: click
 Requires-Dist: pyyaml
+Dynamic: license-file
 
 # halfORM
 

{half_orm-1.0.0rc13 → half_orm-1.0.0rc15}/half_orm/cli.py

@@ -98,6 +98,7 @@ OFFICIAL_EXTENSIONS = {
     'half_orm_test_extension',
     'half_orm_inspect',
     'half_orm_dev',
+    'half_orm_gen'
 }
 
 def get_config_file():

{half_orm-1.0.0rc13 → half_orm-1.0.0rc15}/half_orm/field.py

@@ -6,6 +6,7 @@
 import re
 import sys
 import typing
+import warnings
 import yaml
 from collections.abc import Iterable
 from half_orm.null import NULL
@@ -13,6 +14,9 @@ from half_orm.sql_adapter import SQL_ADAPTER
 from half_orm.sql_ast import FieldExpr
 
 
+_TEXT_LIKE_TYPES = {'text', 'varchar', 'character varying', 'char', 'bpchar', 'name', 'citext'}
+
+
 class Expr:
     """A raw SQL expression for use with :meth:`Field.set`.
 
@@ -167,6 +171,20 @@ class Field():
         """
         return bool(self.__metadata['notnull'])
 
+    @property
+    def has_default_value(self):
+        """The default expression for this column, or ``None`` if there is none.
+
+        Returns the PostgreSQL expression string as stored in ``pg_attrdef``,
+        e.g. ``"nextval('seq'::regclass)"``, ``"'active'::text"``, ``"now()"``.
+
+        Example::
+
+            Author().id.has_default_value        # "nextval('author_id_seq'::regclass)"
+            Author().last_name.has_default_value # None
+        """
+        return self.__metadata.get('default_expr')
+
     def __parse_json_schema(self):
         desc = self.__metadata.get('fielddescription') or ''
         m = re.search(r'@json\s*```yaml\s*(.*?)(?:```|\Z)', desc, re.DOTALL)
@@ -238,7 +256,7 @@ class Field():
             cast = f'::{self.__sql_type}'
         if col_is_array and comp == '=':
             where_repr = f'{comp_str} = ANY({self.__praf(query, ho_id)})'
-        elif not self.unaccent:
+        elif not self.unaccent or not self._is_text_like:
             where_repr = f"{self.__praf(query, ho_id)} {comp} {comp_str}{cast}"
         else:
             where_repr = f"unaccent({self.__praf(query, ho_id)}) {comp} unaccent({comp_str}{cast})"
@@ -282,7 +300,7 @@ class Field():
             comp=comp,
             placeholder=f'{comp_str}{cast}',
             value=self,
-            unaccent=self.unaccent,
+            unaccent=self.unaccent and self._is_text_like,
             array_any=is_array_any,
         )
 
@@ -352,7 +370,7 @@ class Field():
             self.__comp = '='
             self.__unaccent = False
             return
-        self.__unaccent = unaccent
+        self.unaccent = unaccent
         comp = None
         if isinstance(value, tuple):
             if len(value) != 2:
@@ -414,10 +432,22 @@ class Field():
         """
         return self.__unaccent
 
+    @property
+    def _is_text_like(self):
+        base_type = self.__sql_type.lstrip('_')
+        return base_type in _TEXT_LIKE_TYPES
+
     @unaccent.setter
     def unaccent(self, value):
         if not isinstance(value, bool):
             raise RuntimeError('unaccent value must be True or False!')
+        if value and not self._is_text_like:
+            warnings.warn(
+                f"unaccent ignored: field '{self.__name}' has non-text type '{self.__sql_type}'",
+                UserWarning,
+                stacklevel=2,
+            )
+            value = False
         self.__unaccent = value
 
     def _comp(self):

{half_orm-1.0.0rc13 → half_orm-1.0.0rc15}/half_orm/model.py

@@ -41,6 +41,18 @@ CONF_DIR = os.path.abspath(environ.get('HALFORM_CONF_DIR', '/etc/half_orm'))
 
 # UUID is natively supported in psycopg 3
 
+_SQL_TO_JSON = {
+    'uuid': 'string', 'text': 'string', 'varchar': 'string', 'bpchar': 'string',
+    'int4': 'integer', 'int8': 'integer', 'int2': 'integer',
+    'float4': 'number', 'float8': 'number', 'numeric': 'number',
+    'bool': 'boolean',
+    'date': 'date', 'timestamp': 'datetime', 'timestamptz': 'datetime',
+    'jsonb': 'json', 'json': 'json',
+}
+def _sql_to_json_type(sql_type: str) -> str:
+    base = sql_type.lstrip('_')
+    return _SQL_TO_JSON.get(base, 'string')
+
 register = register_class
 
 class Model:
@@ -167,6 +179,106 @@ class Model:
 
     reconnect = __connect
 
+    def ho_meta(self) -> dict:
+        """Return a structured description of all relations visible in the database scope.
+
+        For each relation (table, view, materialized view…) the returned dict maps
+        ``'<schema>/<table>'`` keys to a metadata dict with the following structure::
+
+            {
+                'schema':      str,          # schema name
+                'table':       str,          # relation name
+                'kind':        str,          # 'r' table, 'v' view, 'm' matview, 'p' partition
+                'pk_fields':   list[str],    # primary-key column names
+                'fields': [
+                    {
+                        'name':        str,   # column name
+                        'sql_type':    str,   # PostgreSQL type (e.g. 'text', 'int4')
+                        'json_type':   str,   # JSON schema type (e.g. 'string', 'integer')
+                        'is_pk':       bool,
+                        'not_null':    bool,
+                        'has_default': bool,
+                    },
+                    ...
+                ],
+                'fk_deps': [              # outgoing foreign keys
+                    {
+                        'local_fields':  list[str],
+                        'remote_schema': str,
+                        'remote_table':  str,
+                        'remote_fields': list[str],
+                    },
+                    ...
+                ],
+                'reverse_fks': [          # incoming foreign keys
+                    {
+                        'local_fields':  list[str],
+                        'remote_schema': str,
+                        'remote_table':  str,
+                        'remote_fields': list[str],
+                        'is_singleton':  bool,
+                    },
+                    ...
+                ],
+            }
+
+        Returns:
+            dict: mapping ``'<schema>/<table>'`` → metadata dict (see above).
+
+        Example::
+
+            model = Model('halftest')
+            meta = model.ho_meta()
+            person = meta['actor/person']
+            print(person['kind'])        # 'r'
+            print(person['pk_fields'])   # ['id']
+            for f in person['fields']:
+                print(f['name'], f['sql_type'])
+        """
+        result = {}
+        for kind, sfqrn, _ in self.desc():
+            dbname, schema, table = sfqrn
+            key = f'{schema}/{table}'
+            fields_meta = self._fields_metadata(sfqrn)
+            fkeys_meta = self._fkeys_metadata(sfqrn)
+            pk_fields = self._pkey_constraint(sfqrn)
+
+            fields = []
+            for fname, fdata in fields_meta.items():
+                fields.append({
+                    'name': fname,
+                    'sql_type': fdata['fieldtype'],
+                    'json_type': _sql_to_json_type(fdata['fieldtype']),  # helper à ajouter
+                    'is_pk': bool(fdata.get('pkey')),
+                    'not_null': bool(fdata.get('notnull')),
+                    'has_default': fdata.get('default_expr') is not None,
+                })
+
+            fk_deps, reverse_fks = [], []
+            for fk_name, fk_data in fkeys_meta.items():
+                ftable_key, ffields, local_fields, upd, del_, is_reverse, is_singleton = fk_data
+                _, r_schema, r_table = ftable_key
+                entry = {
+                    'local_fields': local_fields,
+                    'remote_schema': r_schema,
+                    'remote_table': r_table,
+                    'remote_fields': ffields,
+                }
+                if is_reverse:
+                    entry['is_singleton'] = is_singleton
+                    reverse_fks.append(entry)
+                else:
+                    fk_deps.append(entry)
+
+            result[key] = {
+                'schema': schema, 'table': table, 'kind': kind,
+                'pk_fields': pk_fields,
+                'fields': fields,
+                'fk_deps': fk_deps,
+                'reverse_fks': reverse_fks,
+            }
+        return result
+
     def get_relation_class(self, relation_name: str, fields_aliases: typing.Dict=None): # -> Relation
         """Generate a :class:`~half_orm.relation.Relation` subclass for a table or view.
 

{half_orm-1.0.0rc13 → half_orm-1.0.0rc15}/half_orm/pg_meta.py

@@ -111,7 +111,8 @@ SELECT
     cn_fk.confrelid AS fkeytableid,
     cn_fk.confkey AS fkeynum,
     cn_fk.confupdtype as fkey_confupdtype,
-    cn_fk.confdeltype as fkey_confdeltype
+    cn_fk.confdeltype as fkey_confdeltype,
+    pg_get_expr(d.adbin, d.adrelid) AS default_expr
 FROM
     pg_class c -- table
     LEFT JOIN pg_description tdesc ON
@@ -128,6 +129,9 @@ FROM
     adesc.objsubid = a.attnum
     JOIN pg_type pt ON
     a.atttypid = pt.oid
+    LEFT JOIN pg_attrdef d ON
+    d.adrelid = a.attrelid AND
+    d.adnum = a.attnum
     LEFT JOIN pg_constraint cn_uniq ON
     cn_uniq.contype = 'u' AND
     cn_uniq.conrelid = a.attrelid AND
@@ -175,7 +179,9 @@ GROUP BY
     cn_fk.confrelid,
     cn_fk.confkey,
     cn_fk.confupdtype,
-    cn_fk.confdeltype
+    cn_fk.confdeltype,
+    d.adbin,
+    d.adrelid
 ORDER BY
     n.nspname, c.relname, a.attnum
 """

half_orm-1.0.0rc15/half_orm/version.txt

@@ -0,0 +1 @@
+1.0.0rc15

{half_orm-1.0.0rc13 → half_orm-1.0.0rc15/half_orm.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: half_orm
-Version: 1.0.0rc13
+Version: 1.0.0rc15
 Summary: A database-first ORM for PostgreSQL
 Author-email: Joël Maïzi <joel.maizi@collorg.org>
 License: GPL-3.0
@@ -25,6 +25,7 @@ License-File: AUTHORS
 Requires-Dist: psycopg[binary]
 Requires-Dist: click
 Requires-Dist: pyyaml
+Dynamic: license-file
 
 # halfORM
 

{half_orm-1.0.0rc13 → half_orm-1.0.0rc15}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "half_orm"
-version = "1.0.0rc13"
+version = "1.0.0rc15"
 description = "A database-first ORM for PostgreSQL"
 readme = "README.md"
 license = { text = "GPL-3.0" }

half_orm-1.0.0rc13/half_orm/version.txt

@@ -1 +0,0 @@
-1.0.0rc13