vgi-python 0.8.4__py3-none-any.whl → 0.8.5__py3-none-any.whl

vgi/argument_spec.py

@@ -38,6 +38,7 @@ __all__ = [
     "VGI_VARARGS_TRUE",
     "VGI_CONST_KEY",
     "VGI_CONST_TRUE",
+    "VGI_DOC_KEY",
 ]
 
 # =============================================================================
@@ -61,6 +62,11 @@ VGI_VARARGS_TRUE = b"true"
 VGI_CONST_KEY = b"vgi_const"
 VGI_CONST_TRUE = b"true"
 
+# Key carrying the per-argument description (UTF-8 text). Presence-only: the key
+# is omitted entirely when there is no doc (absent = undocumented). The
+# ``vgi_doc_*`` prefix is reserved for future per-argument doc variants.
+VGI_DOC_KEY = b"vgi_doc"
+
 
 def _argument_spec_sort_key(spec: "ArgumentSpec") -> tuple[int, int | str]:
     """Sort key: positional first (by index), then named (alphabetically)."""
@@ -98,6 +104,9 @@ class ArgumentSpec:
         is_const: True if this argument is constant-folded ([`ConstParam`][]).
             Constant arguments are scalar values known at planning time,
             rather than columnar data processed at runtime.
+        doc: Optional human/agent-facing description of the argument. Surfaced
+            through the catalog as the ``vgi_doc`` Arrow field metadata key
+            (UTF-8); empty string means undocumented.
 
     Note:
         For named arguments, the Python attribute name (``name``) and the SQL
@@ -119,6 +128,7 @@ class ArgumentSpec:
     is_any_type: bool = False
     is_varargs: bool = False
     is_const: bool = False
+    doc: str = ""
 
     def __repr__(self) -> str:
         """Return concise repr showing key attributes."""
@@ -197,6 +207,10 @@ def argument_specs_to_schema(specs: Sequence[ArgumentSpec]) -> pa.Schema:
         if spec.is_const:
             metadata[VGI_CONST_KEY] = VGI_CONST_TRUE
 
+        # Per-argument description (UTF-8; presence-only — omit when empty)
+        if spec.doc:
+            metadata[VGI_DOC_KEY] = spec.doc.encode("utf-8")
+
         # Create field with or without metadata
         field = pa.field(
             spec.name,
@@ -246,6 +260,10 @@ def schema_to_argument_specs(schema: pa.Schema) -> list[ArgumentSpec]:
         # Check const
         is_const = metadata.get(VGI_CONST_KEY) == VGI_CONST_TRUE
 
+        # Per-argument description (UTF-8; absent = undocumented)
+        doc_bytes = metadata.get(VGI_DOC_KEY)
+        doc = doc_bytes.decode("utf-8") if doc_bytes else ""
+
         specs.append(
             ArgumentSpec(
                 name=field.name,
@@ -255,6 +273,7 @@ def schema_to_argument_specs(schema: pa.Schema) -> list[ArgumentSpec]:
                 is_any_type=is_any_type,
                 is_varargs=is_varargs,
                 is_const=is_const,
+                doc=doc,
             )
         )
 
@@ -312,6 +331,7 @@ def extract_argument_specs(
                 is_any_type=param_arg.is_any,
                 is_varargs=param_arg.varargs,
                 is_const=False,
+                doc=param_arg.doc or "",
             )
         )
 
@@ -328,6 +348,7 @@ def extract_argument_specs(
                 is_any_type=const_arg.is_any,
                 is_varargs=const_arg.varargs,
                 is_const=True,
+                doc=const_arg.doc or "",
             )
         )
 
@@ -392,6 +413,7 @@ def extract_argument_specs(
                     is_any_type=is_any_type,
                     is_varargs=arg_instance.varargs,
                     is_const=getattr(arg_instance, "const", False),
+                    doc=getattr(arg_instance, "doc", "") or "",
                 )
             )
 
@@ -466,6 +488,7 @@ def extract_argument_specs(
                         is_any_type=is_any_type,
                         is_varargs=is_varargs,
                         is_const=is_const,
+                        doc=getattr(arg_legacy, "doc", "") or "",
                     )
                 )
 

{vgi_python-0.8.4.dist-info → vgi_python-0.8.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vgi-python
-Version: 0.8.4
+Version: 0.8.5
 Summary: Vector Gateway Interface - Connect DuckDB to external programs via Apache Arrow
 Project-URL: Homepage, https://query.farm
 Project-URL: Repository, https://github.com/Query-farm/vgi-python

{vgi_python-0.8.4.dist-info → vgi_python-0.8.5.dist-info}/RECORD

@@ -2,7 +2,7 @@ vgi/__init__.py,sha256=PRtFvXxhHEbY_0KVhyXIbGigZDYKHzMS-4gp0p6IJSQ,3414
 vgi/_duckdb.py,sha256=YB5D7N3Bwg_xP6X8a5QlumtlAovSej1A1Go5XlNGVko,2162
 vgi/_storage_profile.py,sha256=VkTsXojuE0tHEzurmteQSAiL1vI3CZSgYkL6D_h8GvE,5061
 vgi/aggregate_function.py,sha256=vn9TjQEHxAKJl_xzQOzdj5TY_6LplcZjv06JkQMnUyo,25184
-vgi/argument_spec.py,sha256=fVO17BDDfjnTMUrRoILNr2oFLTl4KKedMObFUk2GRrI,17072
+vgi/argument_spec.py,sha256=FFtCNVXhUnEvft51HICOVA7jGJilDW0CHYeyuYexGsg,18142
 vgi/arguments.py,sha256=02tIMGIR_cRS73u-bsgpFERxhje-rnTokjBgGsm9pQA,67019
 vgi/auth.py,sha256=3HD2zM-Mt0Ie-_HT5RorpND1OusUw2CPROjPNs7rgbo,1478
 vgi/exceptions.py,sha256=oX_sZc9xGWi7Xf8cJQf89fX19i3ocDEj_V_76GINgBQ,7294
@@ -122,8 +122,8 @@ vgi/transactor/_duckdb_compat.py,sha256=sXVZ9JLKAQyGR1BjWczSwdQEavtr-TcZPoVZZnTr
 vgi/transactor/client.py,sha256=7DTeMksogsw6ANjQjGOPpKYrV76rg4_kGjktMJf54jg,4486
 vgi/transactor/protocol.py,sha256=Mtmll3CdrLFL1B4NY4NZUTO_yi3PT0qhvMQnzapuBWU,4780
 vgi/transactor/server.py,sha256=WpIqjzy2Mebw17Jui4-w7vyGEo9pD-pEZJG-3Ob1Sk8,29705
-vgi_python-0.8.4.dist-info/METADATA,sha256=AiJ8ZL_UJ96RP297iwcuoQsUlafMdGR1yr216r8apjA,24725
-vgi_python-0.8.4.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-vgi_python-0.8.4.dist-info/entry_points.txt,sha256=3Kz1vgodw3pOL_xjtSyDB55-ZRy-U2X-X_Bdr582x0Q,165
-vgi_python-0.8.4.dist-info/licenses/LICENSE,sha256=pbJb4zZasP6n5ifEV81wFu017TarjydaYVmGbHcehtY,6103
-vgi_python-0.8.4.dist-info/RECORD,,
+vgi_python-0.8.5.dist-info/METADATA,sha256=1dqjWdLcM1MrxAIF8CVYkGA8YCaZF3T5pamDdUYdIj0,24725
+vgi_python-0.8.5.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+vgi_python-0.8.5.dist-info/entry_points.txt,sha256=3Kz1vgodw3pOL_xjtSyDB55-ZRy-U2X-X_Bdr582x0Q,165
+vgi_python-0.8.5.dist-info/licenses/LICENSE,sha256=pbJb4zZasP6n5ifEV81wFu017TarjydaYVmGbHcehtY,6103
+vgi_python-0.8.5.dist-info/RECORD,,