PyPI - polypheny-prism-api - Versions diffs - 2.1__tar.gz → 2.2__tar.gz - Mend

polypheny-prism-api 2.1tar.gz → 2.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (33) hide show

polypheny_prism_api-2.2/PKG-INFO ADDED Viewed

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: polypheny-prism-api
+Version: 2.2
+Summary: Polypheny Prism API files for Python
+Home-page: https://polypheny.com/
+Author: The Polypheny Project
+Author-email: mail@polypheny.org
+License: Apache License, Version 2.0
+Project-URL: Documentation, https://docs.polypheny.com/en/latest/query_interfaces/prism/protocol
+Project-URL: Code, https://github.com/polypheny/Polypheny-Prism-API
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf==5.27.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
+# Polypheny-Prism-API
+The definition files for the Polypheny Prism API, a multi-model, multi-language query interface.
+The Prism Interface uses Protocol Buffer (protobuf) messages to define it's services. To keep things clear and well-organized, the message definitions are grouped into several files. This simplifies finding specific messages, based on what they do or what part of the system they relate to. The files itself are grouped in categories. Those are expressed in the file names.
+Two kinds of categories exist:
+### Request Response Category
+The category type contains messages that are used in communication adhering to a request, response scheme. Here the client sends a request message to the server upon which the server sends back a response message.
+- **Requests File**: This file contains all messages that are sent from the client to the server. The file name adheres to the following pattern: `[category]_requests.proto`. For example, all the request messages for making or managing connections would be in `connection_requests.proto`.
+- **Responses File**: This is the partner file to Requests. It contains all the messages the server sends back to the client. Following the naming pattern, these files end with `_responses.proto`. The response messages related to connections would thus be in `connection_responses.proto`.
+### Other Category
+The other kind of category contains messages that are not directly used as a response to a request. An example therefore would be messages representing a specific datatype supported by the DBMS.
+This category always contains only one file. The filename adheres to the pattern `[category].proto`.
+### Doc Generator
+Detailed Documentation of the proto files their messages and enums and much more can automatically be created using the doc generator included in this repo.
+For this to work, the protobuf compiler must be installed. It's current version can be downloaded [here](https://github.com/protocolbuffers/protobuf/releases/).
+To run the doc generator, execute the file `generator.py` in the `doc-generator` directory.
+This creates a directory called docs containing the generated documentation.
+### Generate Python files
+Generate the Python code:
+```
+python -m grpc_tools.protoc -I . --python_out . org/polypheny/prism/*.proto
+```
+### Test protocol contracts
+The Python contract tests compile the checked-out definitions into a temporary directory
+and check the document metadata messages, wire compatibility, and optional-field presence.
+```
+python -m pip install -r requirements.txt
+python -m unittest discover -s tests -v
+```

{polypheny-prism-api-2.1 → polypheny_prism_api-2.2}/README.md RENAMED Viewed

@@ -30,3 +30,13 @@ Generate the Python code:
 ```
 python -m grpc_tools.protoc -I . --python_out . org/polypheny/prism/*.proto
 ```
+### Test protocol contracts
+The Python contract tests compile the checked-out definitions into a temporary directory
+and check the document metadata messages, wire compatibility, and optional-field presence.
+```
+python -m pip install -r requirements.txt
+python -m unittest discover -s tests -v
+```

{polypheny-prism-api-2.1 → polypheny_prism_api-2.2}/org/polypheny/prism/namespace_meta_responses_pb2.py RENAMED Viewed

@@ -14,7 +14,7 @@ _sym_db = _symbol_database.Default()
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n2org/polypheny/prism/namespace_meta_responses.proto\x12\x13org.polypheny.prism\"H\n\x12NamespacesResponse\x12\x32\n\nnamespaces\x18\x01 \x03(\x0b\x32\x1e.org.polypheny.prism.Namespace\"A\n\x10\x45ntitiesResponse\x12-\n\x08\x65ntities\x18\x01 \x03(\x0b\x32\x1b.org.polypheny.prism.Entity\"n\n\tNamespace\x12\x16\n\x0enamespace_name\x18\x01 \x01(\t\x12\x19\n\x11is_case_sensitive\x18\x04 \x01(\x08\x12\x1b\n\x0enamespace_type\x18\x05 \x01(\tH\x00\x88\x01\x01\x42\x11\n\x0f_namespace_type\"\x9f\x01\n\x06\x45ntity\x12+\n\x05table\x18\x01 \x01(\x0b\x32\x1a.org.polypheny.prism.TableH\x00\x12+\n\x05graph\x18\x02 \x01(\x0b\x32\x1a.org.polypheny.prism.GraphH\x00\x12\x31\n\x08\x64ocument\x18\x03 \x01(\x0b\x32\x1d.org.polypheny.prism.DocumentH\x00\x42\x08\n\x06\x45ntity\"\xdc\x02\n\x05Table\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12\x12\n\ntable_type\x18\x04 \x01(\t\x12,\n\x07\x63olumns\x18\x06 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x39\n\x0bprimary_key\x18\x07 \x01(\x0b\x32\x1f.org.polypheny.prism.PrimaryKeyH\x00\x88\x01\x01\x12\x35\n\x0c\x66oreign_keys\x18\x08 \x03(\x0b\x32\x1f.org.polypheny.prism.ForeignKey\x12\x36\n\rexported_keys\x18\t \x03(\x0b\x32\x1f.org.polypheny.prism.ForeignKey\x12+\n\x07indexes\x18\n \x03(\x0b\x32\x1a.org.polypheny.prism.IndexB\x0e\n\x0c_primary_key\"\xda\x03\n\x06\x43olumn\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12\x13\n\x0b\x63olumn_name\x18\x04 \x01(\t\x12\x11\n\ttype_name\x18\x05 \x01(\t\x12\x18\n\x0btype_length\x18\x06 \x01(\x05H\x00\x88\x01\x01\x12\x17\n\ntype_scale\x18\x07 \x01(\x05H\x01\x88\x01\x01\x12\x13\n\x0bis_nullable\x18\x08 \x01(\x08\x12$\n\x17\x64\x65\x66\x61ult_value_as_string\x18\t \x01(\tH\x02\x88\x01\x01\x12\x14\n\x0c\x63olumn_index\x18\n \x01(\x05\x12\x16\n\tcollation\x18\x0b \x01(\tH\x03\x88\x01\x01\x12\x11\n\tis_hidden\x18\x0c \x01(\x08\x12;\n\x0b\x63olumn_type\x18\r \x01(\x0e\x32&.org.polypheny.prism.Column.ColumnType\"G\n\nColumnType\x12\x0f\n\x0bUNSPECIFIED\x10\x00\x12\x0b\n\x07REGULAR\x10\x01\x12\x0e\n\nCALCULATED\x10\x02\x12\x0b\n\x07VERSION\x10\x03\x42\x0e\n\x0c_type_lengthB\r\n\x0b_type_scaleB\x1a\n\x18_default_value_as_stringB\x0c\n\n_collation\"}\n\nPrimaryKey\x12\x15\n\rdatabase_name\x18\x01 \x01(\t\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12,\n\x07\x63olumns\x18\x04 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\"\xae\x02\n\nForeignKey\x12&\n\x19referenced_namespace_name\x18\x02 \x01(\tH\x00\x88\x01\x01\x12\x1d\n\x15referenced_table_name\x18\x03 \x01(\t\x12\x37\n\x12referenced_columns\x18\x04 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x34\n\x0f\x66oreign_columns\x18\x08 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x13\n\x0bupdate_rule\x18\n \x01(\x05\x12\x13\n\x0b\x64\x65lete_rule\x18\x0b \x01(\x05\x12\x15\n\x08key_name\x18\x0c \x01(\tH\x01\x88\x01\x01\x42\x1c\n\x1a_referenced_namespace_nameB\x0b\n\t_key_name\"\xab\x01\n\x05Index\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12\x0e\n\x06unique\x18\x04 \x01(\x08\x12\x12\n\nindex_name\x18\x05 \x01(\t\x12,\n\x07\x63olumns\x18\x06 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x10\n\x08location\x18\x08 \x01(\x03\x12\x12\n\nindex_type\x18\t \x01(\x05\"\x07\n\x05Graph\"\n\n\x08\x44ocumentB\\\n\x13org.polypheny.prismB\x16NamespaceMetaResponsesP\x01Z\x19org/polypheny/prism;prism\xaa\x02\x0fPolypheny.Prismb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n2org/polypheny/prism/namespace_meta_responses.proto\x12\x13org.polypheny.prism\"H\n\x12NamespacesResponse\x12\x32\n\nnamespaces\x18\x01 \x03(\x0b\x32\x1e.org.polypheny.prism.Namespace\"A\n\x10\x45ntitiesResponse\x12-\n\x08\x65ntities\x18\x01 \x03(\x0b\x32\x1b.org.polypheny.prism.Entity\"n\n\tNamespace\x12\x16\n\x0enamespace_name\x18\x01 \x01(\t\x12\x19\n\x11is_case_sensitive\x18\x04 \x01(\x08\x12\x1b\n\x0enamespace_type\x18\x05 \x01(\tH\x00\x88\x01\x01\x42\x11\n\x0f_namespace_type\"\x9f\x01\n\x06\x45ntity\x12+\n\x05table\x18\x01 \x01(\x0b\x32\x1a.org.polypheny.prism.TableH\x00\x12+\n\x05graph\x18\x02 \x01(\x0b\x32\x1a.org.polypheny.prism.GraphH\x00\x12\x31\n\x08\x64ocument\x18\x03 \x01(\x0b\x32\x1d.org.polypheny.prism.DocumentH\x00\x42\x08\n\x06\x45ntity\"\xdc\x02\n\x05Table\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12\x12\n\ntable_type\x18\x04 \x01(\t\x12,\n\x07\x63olumns\x18\x06 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x39\n\x0bprimary_key\x18\x07 \x01(\x0b\x32\x1f.org.polypheny.prism.PrimaryKeyH\x00\x88\x01\x01\x12\x35\n\x0c\x66oreign_keys\x18\x08 \x03(\x0b\x32\x1f.org.polypheny.prism.ForeignKey\x12\x36\n\rexported_keys\x18\t \x03(\x0b\x32\x1f.org.polypheny.prism.ForeignKey\x12+\n\x07indexes\x18\n \x03(\x0b\x32\x1a.org.polypheny.prism.IndexB\x0e\n\x0c_primary_key\"\xda\x03\n\x06\x43olumn\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12\x13\n\x0b\x63olumn_name\x18\x04 \x01(\t\x12\x11\n\ttype_name\x18\x05 \x01(\t\x12\x18\n\x0btype_length\x18\x06 \x01(\x05H\x00\x88\x01\x01\x12\x17\n\ntype_scale\x18\x07 \x01(\x05H\x01\x88\x01\x01\x12\x13\n\x0bis_nullable\x18\x08 \x01(\x08\x12$\n\x17\x64\x65\x66\x61ult_value_as_string\x18\t \x01(\tH\x02\x88\x01\x01\x12\x14\n\x0c\x63olumn_index\x18\n \x01(\x05\x12\x16\n\tcollation\x18\x0b \x01(\tH\x03\x88\x01\x01\x12\x11\n\tis_hidden\x18\x0c \x01(\x08\x12;\n\x0b\x63olumn_type\x18\r \x01(\x0e\x32&.org.polypheny.prism.Column.ColumnType\"G\n\nColumnType\x12\x0f\n\x0bUNSPECIFIED\x10\x00\x12\x0b\n\x07REGULAR\x10\x01\x12\x0e\n\nCALCULATED\x10\x02\x12\x0b\n\x07VERSION\x10\x03\x42\x0e\n\x0c_type_lengthB\r\n\x0b_type_scaleB\x1a\n\x18_default_value_as_stringB\x0c\n\n_collation\"}\n\nPrimaryKey\x12\x15\n\rdatabase_name\x18\x01 \x01(\t\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12,\n\x07\x63olumns\x18\x04 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\"\xae\x02\n\nForeignKey\x12&\n\x19referenced_namespace_name\x18\x02 \x01(\tH\x00\x88\x01\x01\x12\x1d\n\x15referenced_table_name\x18\x03 \x01(\t\x12\x37\n\x12referenced_columns\x18\x04 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x34\n\x0f\x66oreign_columns\x18\x08 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x13\n\x0bupdate_rule\x18\n \x01(\x05\x12\x13\n\x0b\x64\x65lete_rule\x18\x0b \x01(\x05\x12\x15\n\x08key_name\x18\x0c \x01(\tH\x01\x88\x01\x01\x42\x1c\n\x1a_referenced_namespace_nameB\x0b\n\t_key_name\"\xab\x01\n\x05Index\x12\x16\n\x0enamespace_name\x18\x02 \x01(\t\x12\x12\n\ntable_name\x18\x03 \x01(\t\x12\x0e\n\x06unique\x18\x04 \x01(\x08\x12\x12\n\nindex_name\x18\x05 \x01(\t\x12,\n\x07\x63olumns\x18\x06 \x03(\x0b\x32\x1b.org.polypheny.prism.Column\x12\x10\n\x08location\x18\x08 \x01(\x03\x12\x12\n\nindex_type\x18\t \x01(\x05\"\x07\n\x05Graph\"\xe9\x01\n\x08\x44ocument\x12\x16\n\x0enamespace_name\x18\x01 \x01(\t\x12\x17\n\x0f\x63ollection_name\x18\x02 \x01(\t\x12\x32\n\x06\x66ields\x18\x03 \x03(\x0b\x32\".org.polypheny.prism.DocumentField\x12!\n\x14sample_document_json\x18\x04 \x01(\tH\x00\x88\x01\x01\x12<\n\x10\x64ocument_indexes\x18\x05 \x03(\x0b\x32\".org.polypheny.prism.DocumentIndexB\x17\n\x15_sample_document_json\"K\n\rDocumentField\x12\x12\n\nfield_path\x18\x01 \x01(\t\x12\x11\n\ttype_name\x18\x02 \x01(\t\x12\x13\n\x0bis_optional\x18\x03 \x01(\x08\"G\n\rDocumentIndex\x12\x12\n\nfield_path\x18\x01 \x01(\t\x12\x12\n\nindex_type\x18\x02 \x01(\t\x12\x0e\n\x06unique\x18\x03 \x01(\x08\x42\\\n\x13org.polypheny.prismB\x16NamespaceMetaResponsesP\x01Z\x19org/polypheny/prism;prism\xaa\x02\x0fPolypheny.Prismb\x06proto3')
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -44,6 +44,10 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_INDEX']._serialized_end=1922
   _globals['_GRAPH']._serialized_start=1924
   _globals['_GRAPH']._serialized_end=1931
-  _globals['_DOCUMENT']._serialized_start=1933
-  _globals['_DOCUMENT']._serialized_end=1943
+  _globals['_DOCUMENT']._serialized_start=1934
+  _globals['_DOCUMENT']._serialized_end=2167
+  _globals['_DOCUMENTFIELD']._serialized_start=2169
+  _globals['_DOCUMENTFIELD']._serialized_end=2244
+  _globals['_DOCUMENTINDEX']._serialized_start=2246
+  _globals['_DOCUMENTINDEX']._serialized_end=2317
 # @@protoc_insertion_point(module_scope)

{polypheny-prism-api-2.1 → polypheny_prism_api-2.2}/org/polypheny/prism/version.py RENAMED Viewed

@@ -1,2 +1,2 @@
 MAJOR_VERSION = 2
-MINOR_VERSION = 1
+MINOR_VERSION = 2

polypheny_prism_api-2.2/polypheny_prism_api.egg-info/PKG-INFO ADDED Viewed

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: polypheny-prism-api
+Version: 2.2
+Summary: Polypheny Prism API files for Python
+Home-page: https://polypheny.com/
+Author: The Polypheny Project
+Author-email: mail@polypheny.org
+License: Apache License, Version 2.0
+Project-URL: Documentation, https://docs.polypheny.com/en/latest/query_interfaces/prism/protocol
+Project-URL: Code, https://github.com/polypheny/Polypheny-Prism-API
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf==5.27.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
+# Polypheny-Prism-API
+The definition files for the Polypheny Prism API, a multi-model, multi-language query interface.
+The Prism Interface uses Protocol Buffer (protobuf) messages to define it's services. To keep things clear and well-organized, the message definitions are grouped into several files. This simplifies finding specific messages, based on what they do or what part of the system they relate to. The files itself are grouped in categories. Those are expressed in the file names.
+Two kinds of categories exist:
+### Request Response Category
+The category type contains messages that are used in communication adhering to a request, response scheme. Here the client sends a request message to the server upon which the server sends back a response message.
+- **Requests File**: This file contains all messages that are sent from the client to the server. The file name adheres to the following pattern: `[category]_requests.proto`. For example, all the request messages for making or managing connections would be in `connection_requests.proto`.
+- **Responses File**: This is the partner file to Requests. It contains all the messages the server sends back to the client. Following the naming pattern, these files end with `_responses.proto`. The response messages related to connections would thus be in `connection_responses.proto`.
+### Other Category
+The other kind of category contains messages that are not directly used as a response to a request. An example therefore would be messages representing a specific datatype supported by the DBMS.
+This category always contains only one file. The filename adheres to the pattern `[category].proto`.
+### Doc Generator
+Detailed Documentation of the proto files their messages and enums and much more can automatically be created using the doc generator included in this repo.
+For this to work, the protobuf compiler must be installed. It's current version can be downloaded [here](https://github.com/protocolbuffers/protobuf/releases/).
+To run the doc generator, execute the file `generator.py` in the `doc-generator` directory.
+This creates a directory called docs containing the generated documentation.
+### Generate Python files
+Generate the Python code:
+```
+python -m grpc_tools.protoc -I . --python_out . org/polypheny/prism/*.proto
+```
+### Test protocol contracts
+The Python contract tests compile the checked-out definitions into a temporary directory
+and check the document metadata messages, wire compatibility, and optional-field presence.
+```
+python -m pip install -r requirements.txt
+python -m unittest discover -s tests -v
+```

{polypheny-prism-api-2.1 → polypheny_prism_api-2.2}/polypheny_prism_api.egg-info/SOURCES.txt RENAMED Viewed

@@ -24,4 +24,5 @@ polypheny_prism_api.egg-info/PKG-INFO
 polypheny_prism_api.egg-info/SOURCES.txt
 polypheny_prism_api.egg-info/dependency_links.txt
 polypheny_prism_api.egg-info/requires.txt
-polypheny_prism_api.egg-info/top_level.txt
+polypheny_prism_api.egg-info/top_level.txt
+tests/test_document_metadata.py

polypheny_prism_api-2.2/prism-api-version.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ 2.2

polypheny_prism_api-2.2/tests/test_document_metadata.py ADDED Viewed

@@ -0,0 +1,158 @@
+"""Contract tests generated from the actual Prism protocol definitions.
+Run with: python -m unittest discover -s tests -v
+"""
+import importlib
+import json
+from pathlib import Path
+import subprocess
+import sys
+import tempfile
+import unittest
+from google.protobuf import descriptor_pb2, descriptor_pool, message_factory
+class DocumentMetadataContractTest(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.generated = tempfile.TemporaryDirectory()
+        cls.addClassCleanup(cls.generated.cleanup)
+        root = Path(__file__).resolve().parents[1]
+        proto_files = sorted(root.glob("org/polypheny/prism/*.proto"))
+        subprocess.run(
+            [sys.executable, "-m", "grpc_tools.protoc", f"-I{root}",
+             f"--python_out={cls.generated.name}"]
+            + [str(path) for path in proto_files],
+            check=True,
+        )
+        sys.path.insert(0, cls.generated.name)
+        cls.addClassCleanup(sys.path.remove, cls.generated.name)
+        cls.meta = importlib.import_module(
+            "org.polypheny.prism.namespace_meta_responses_pb2"
+        )
+    def test_field_numbers_types_and_cardinality(self):
+        field = descriptor_pb2.FieldDescriptorProto
+        expected = {
+            "Document": [
+                ("namespace_name", 1, field.TYPE_STRING, False),
+                ("collection_name", 2, field.TYPE_STRING, False),
+                ("fields", 3, field.TYPE_MESSAGE, True),
+                ("sample_document_json", 4, field.TYPE_STRING, False),
+                ("document_indexes", 5, field.TYPE_MESSAGE, True),
+            ],
+            "DocumentField": [
+                ("field_path", 1, field.TYPE_STRING, False),
+                ("type_name", 2, field.TYPE_STRING, False),
+                ("is_optional", 3, field.TYPE_BOOL, False),
+            ],
+            "DocumentIndex": [
+                ("field_path", 1, field.TYPE_STRING, False),
+                ("index_type", 2, field.TYPE_STRING, False),
+                ("unique", 3, field.TYPE_BOOL, False),
+            ],
+        }
+        for name, fields in expected.items():
+            with self.subTest(message=name):
+                actual = getattr(self.meta, name).DESCRIPTOR.fields
+                self.assertEqual(
+                    [(item.name, item.number, item.type,
+                      item.label == field.LABEL_REPEATED) for item in actual],
+                    fields,
+                )
+        self.assertEqual(
+            self.meta.Document.DESCRIPTOR.fields_by_name["fields"].message_type.full_name,
+            "org.polypheny.prism.DocumentField",
+        )
+        self.assertEqual(
+            self.meta.Document.DESCRIPTOR.fields_by_name["document_indexes"].message_type.full_name,
+            "org.polypheny.prism.DocumentIndex",
+        )
+    def test_all_metadata_survives_entities_response_round_trip(self):
+        sample = {"patient_id": "p1", "complications": {"renal": None},
+                  "literal.key": "value", r"path\key": True}
+        response = self.meta.EntitiesResponse()
+        document = response.entities.add().document
+        document.namespace_name = "patients_symptoms"
+        document.collection_name = "symptoms"
+        document.fields.add(field_path="patient_id", type_name="string", is_optional=False)
+        document.fields.add(field_path="complications", type_name="object", is_optional=True)
+        document.fields.add(field_path="complications.renal", type_name="null", is_optional=True)
+        document.fields.add(field_path=r"literal\.key", type_name="string", is_optional=False)
+        document.fields.add(field_path=r"path\\key", type_name="bool", is_optional=False)
+        document.sample_document_json = json.dumps(sample)
+        document.document_indexes.add(field_path="patient_id", index_type="hash", unique=True)
+        document.document_indexes.add(field_path="complications.renal", index_type="btree", unique=False)
+        document.document_indexes.add(field_path=r"literal\.key", index_type="hash", unique=False)
+        result = self.meta.EntitiesResponse.FromString(response.SerializeToString())
+        self.assertEqual(result, response)
+        self.assertEqual(result.entities[0].WhichOneof("Entity"), "document")
+        actual = result.entities[0].document
+        self.assertEqual(actual.namespace_name, "patients_symptoms")
+        self.assertEqual(actual.collection_name, "symptoms")
+        self.assertEqual(
+            [(item.field_path, item.type_name, item.is_optional) for item in actual.fields],
+            [("patient_id", "string", False), ("complications", "object", True),
+             ("complications.renal", "null", True), (r"literal\.key", "string", False),
+             (r"path\\key", "bool", False)],
+        )
+        self.assertTrue(actual.HasField("sample_document_json"))
+        self.assertEqual(json.loads(actual.sample_document_json), sample)
+        self.assertEqual(
+            [(item.field_path, item.index_type, item.unique) for item in actual.document_indexes],
+            [("patient_id", "hash", True), ("complications.renal", "btree", False),
+             (r"literal\.key", "hash", False)],
+        )
+    def test_sample_presence_and_empty_collection(self):
+        document = self.meta.Document(namespace_name="ns", collection_name="empty")
+        self.assertFalse(document.HasField("sample_document_json"))
+        self.assertEqual(list(document.fields), [])
+        self.assertEqual(list(document.document_indexes), [])
+        copy = self.meta.Document.FromString(document.SerializeToString())
+        self.assertFalse(copy.HasField("sample_document_json"))
+        document.sample_document_json = ""
+        copy = self.meta.Document.FromString(document.SerializeToString())
+        self.assertTrue(copy.HasField("sample_document_json"))
+        document.ClearField("sample_document_json")
+        self.assertFalse(document.HasField("sample_document_json"))
+    def test_document_uses_existing_entity_oneof(self):
+        entity = self.meta.Entity()
+        entity.document.collection_name = "symptoms"
+        self.assertTrue(entity.HasField("document"))
+        self.assertFalse(entity.HasField("table"))
+        self.assertFalse(entity.HasField("graph"))
+        self.assertEqual(entity.DESCRIPTOR.fields_by_name["document"].number, 3)
+        entity.table.table_name = "patients"
+        self.assertFalse(entity.HasField("document"))
+        self.assertEqual(entity.WhichOneof("Entity"), "table")
+    def test_old_empty_document_readers_preserve_unknown_metadata(self):
+        # Model the previous empty Document definition in an isolated descriptor pool.
+        legacy = descriptor_pb2.FileDescriptorProto(
+            name="legacy_document.proto", package="org.polypheny.prism", syntax="proto3"
+        )
+        legacy.message_type.add(name="Document")
+        pool = descriptor_pool.DescriptorPool()
+        pool.Add(legacy)
+        legacy_document = message_factory.GetMessageClass(
+            pool.FindMessageTypeByName("org.polypheny.prism.Document")
+        )
+        document = self.meta.Document(
+            namespace_name="ns", collection_name="symptoms", sample_document_json="{}"
+        )
+        document.fields.add(field_path="_id", type_name="string", is_optional=False)
+        document.document_indexes.add(field_path="_id", index_type="hash", unique=True)
+        old_reader = legacy_document.FromString(document.SerializeToString())
+        self.assertEqual(
+            self.meta.Document.FromString(old_reader.SerializeToString()), document
+        )
+if __name__ == "__main__":
+    unittest.main()

polypheny-prism-api-2.1/PKG-INFO DELETED Viewed

@@ -1,45 +0,0 @@
-Metadata-Version: 2.1
-Name: polypheny-prism-api
-Version: 2.1
-Summary: Polypheny Prism API files for Python
-Home-page: https://polypheny.com/
-Author: The Polypheny Project
-Author-email: mail@polypheny.org
-License: Apache License, Version 2.0
-Project-URL: Documentation, https://docs.polypheny.com/en/latest/query_interfaces/prism/protocol
-Project-URL: Code, https://github.com/polypheny/Polypheny-Prism-API
-Description: # Polypheny-Prism-API
-        The definition files for the Polypheny Prism API, a multi-model, multi-language query interface.
-        The Prism Interface uses Protocol Buffer (protobuf) messages to define it's services. To keep things clear and well-organized, the message definitions are grouped into several files. This simplifies finding specific messages, based on what they do or what part of the system they relate to. The files itself are grouped in categories. Those are expressed in the file names.
-        Two kinds of categories exist:
-        ### Request Response Category
-        The category type contains messages that are used in communication adhering to a request, response scheme. Here the client sends a request message to the server upon which the server sends back a response message.
-        - **Requests File**: This file contains all messages that are sent from the client to the server. The file name adheres to the following pattern: `[category]_requests.proto`. For example, all the request messages for making or managing connections would be in `connection_requests.proto`.
-        - **Responses File**: This is the partner file to Requests. It contains all the messages the server sends back to the client. Following the naming pattern, these files end with `_responses.proto`. The response messages related to connections would thus be in `connection_responses.proto`.
-        ### Other Category
-        The other kind of category contains messages that are not directly used as a response to a request. An example therefore would be messages representing a specific datatype supported by the DBMS.
-        This category always contains only one file. The filename adheres to the pattern `[category].proto`.
-        ### Doc Generator
-        Detailed Documentation of the proto files their messages and enums and much more can automatically be created using the doc generator included in this repo.
-        For this to work, the protobuf compiler must be installed. It's current version can be downloaded [here](https://github.com/protocolbuffers/protobuf/releases/).
-        To run the doc generator, execute the file `generator.py` in the `doc-generator` directory.
-        This creates a directory called docs containing the generated documentation.
-        ### Generate Python files
-        Generate the Python code:
-        ```
-        python -m grpc_tools.protoc -I . --python_out . org/polypheny/prism/*.proto
-        ```
-Platform: UNKNOWN
-Description-Content-Type: text/markdown

polypheny-prism-api-2.1/polypheny_prism_api.egg-info/PKG-INFO DELETED Viewed

@@ -1,45 +0,0 @@
-Metadata-Version: 2.1
-Name: polypheny-prism-api
-Version: 2.1
-Summary: Polypheny Prism API files for Python
-Home-page: https://polypheny.com/
-Author: The Polypheny Project
-Author-email: mail@polypheny.org
-License: Apache License, Version 2.0
-Project-URL: Documentation, https://docs.polypheny.com/en/latest/query_interfaces/prism/protocol
-Project-URL: Code, https://github.com/polypheny/Polypheny-Prism-API
-Description: # Polypheny-Prism-API
-        The definition files for the Polypheny Prism API, a multi-model, multi-language query interface.
-        The Prism Interface uses Protocol Buffer (protobuf) messages to define it's services. To keep things clear and well-organized, the message definitions are grouped into several files. This simplifies finding specific messages, based on what they do or what part of the system they relate to. The files itself are grouped in categories. Those are expressed in the file names.
-        Two kinds of categories exist:
-        ### Request Response Category
-        The category type contains messages that are used in communication adhering to a request, response scheme. Here the client sends a request message to the server upon which the server sends back a response message.
-        - **Requests File**: This file contains all messages that are sent from the client to the server. The file name adheres to the following pattern: `[category]_requests.proto`. For example, all the request messages for making or managing connections would be in `connection_requests.proto`.
-        - **Responses File**: This is the partner file to Requests. It contains all the messages the server sends back to the client. Following the naming pattern, these files end with `_responses.proto`. The response messages related to connections would thus be in `connection_responses.proto`.
-        ### Other Category
-        The other kind of category contains messages that are not directly used as a response to a request. An example therefore would be messages representing a specific datatype supported by the DBMS.
-        This category always contains only one file. The filename adheres to the pattern `[category].proto`.
-        ### Doc Generator
-        Detailed Documentation of the proto files their messages and enums and much more can automatically be created using the doc generator included in this repo.
-        For this to work, the protobuf compiler must be installed. It's current version can be downloaded [here](https://github.com/protocolbuffers/protobuf/releases/).
-        To run the doc generator, execute the file `generator.py` in the `doc-generator` directory.
-        This creates a directory called docs containing the generated documentation.
-        ### Generate Python files
-        Generate the Python code:
-        ```
-        python -m grpc_tools.protoc -I . --python_out . org/polypheny/prism/*.proto
-        ```
-Platform: UNKNOWN
-Description-Content-Type: text/markdown