arkindex-client 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

arkindex/schema/validator.py

@@ -1,54 +1,22 @@
 # -*- coding: utf-8 -*-
-import re
 import typing
 
 import typesystem
 
 from arkindex.schema.openapi import OPEN_API, OpenAPI
 
-ENCODING_CHOICES = ["json", "yaml", None]
 
-# The regexs give us a best-guess for the encoding if none is specified.
-# They check to see if the document looks like it is probably a YAML object or
-# probably a JSON object. It'll typically be best to specify the encoding
-# explicitly, but this should do for convenience.
-INFER_YAML = re.compile(r"^([ \t]*#.*\n|---[ \t]*\n)*\s*[A-Za-z0-9_-]+[ \t]*:")
-INFER_JSON = re.compile(r'^\s*{\s*"[A-Za-z0-9_-]+"\s*:')
-
-
-def validate(schema: typing.Union[dict, str, bytes], encoding: str = None):
+def validate(schema: typing.Union[dict, str, bytes]):
     if not isinstance(schema, (dict, str, bytes)):
         raise ValueError("schema must be either str, bytes, or dict.")
-    if encoding not in ENCODING_CHOICES:
-        raise ValueError(f"encoding must be one of {ENCODING_CHOICES!r}")
 
     if isinstance(schema, bytes):
         schema = schema.decode("utf8", "ignore")
 
     if isinstance(schema, str):
-        if encoding is None:
-            if INFER_YAML.match(schema):
-                encoding = "yaml"
-            elif INFER_JSON.match(schema):
-                encoding = "json"
-            else:
-                text = "Could not determine if content is JSON or YAML."
-                code = "unknown_encoding"
-                position = typesystem.Position(line_no=1, column_no=1, char_index=0)
-                raise typesystem.ParseError(text=text, code=code, position=position)
-
-        tokenize = {"yaml": typesystem.tokenize_yaml, "json": typesystem.tokenize_json}[
-            encoding
-        ]
-        token = tokenize(schema)
-        value = token.value
-    else:
-        token = None
-        value = schema
-
-    if token is not None:
+        token = typesystem.tokenize_json(schema)
         value = typesystem.validate_with_positions(token=token, validator=OpenAPI)
     else:
-        value = OPEN_API.validate(value)
+        value = OPEN_API.validate(schema)
 
     return OpenAPI().load(value)

{arkindex_client-1.1.1.dist-info → arkindex_client-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arkindex-client
-Version: 1.1.1
+Version: 1.1.3
 Summary: API client for the Arkindex project
 Home-page: https://gitlab.teklia.com/arkindex/api-client
 Author: Teklia <contact@teklia.com>
@@ -20,9 +20,8 @@ Classifier: Topic :: Text Processing :: Indexing
 Classifier: Topic :: Text Processing :: Linguistic
 Requires-Python: >=3.8
 License-File: LICENSE
-Requires-Dist: PyYAML==6.0.2
 Requires-Dist: requests~=2.28
 Requires-Dist: tenacity==8.2.3
-Requires-Dist: typesystem==0.2.5
+Requires-Dist: typesystem==0.4.1
 
 Documentation is available at https://api.arkindex.org

arkindex_client-1.1.3.dist-info/RECORD

@@ -0,0 +1,20 @@
+apistar/__init__.py,sha256=mX65SD-MGA1ZynGKkqh7zEONxAIMsPktTaAXeh69Kwc,231
+apistar/exceptions.py,sha256=yzjDlUB5o0xaORBabqTXmf4ckYjNHz1ceV8ECg3jDek,328
+arkindex/__init__.py,sha256=OBw25Nwe6r1AN3a36-8lnUcDy3nkDIiebBgYNK2Zo9o,99
+arkindex/auth.py,sha256=OeuzFeCQ8FAt0kqPECjsEz-Ki9__-y69z5sAuyTZ28c,1550
+arkindex/compat.py,sha256=Kjxu--QoF8sBxKOvXMtNcDQ0XK7MLc_2C8Q2knll4Lk,805
+arkindex/document.py,sha256=YyqSm3Kc35j3iWuJujyfrLfMy-gNydBtmcR45pUtfC4,3732
+arkindex/exceptions.py,sha256=hDxbgC7uAD8wbTQS1DaEJZ25Nun41Io8Y0BiwrZ1ZSM,2016
+arkindex/mock.py,sha256=olYBFCkLQuuf9gGu7wlmZiLFMQknGGi8evS531RjjUE,2755
+arkindex/pagination.py,sha256=kzOyl2oMqGyyVy7LG7eKK9wAI6YdVzEeOuBEbkdw5Zo,11002
+arkindex/client/__init__.py,sha256=g_G_bSfMbduYzpi9iURTn0cYLV4nMulDR8rD7x-DLyc,142
+arkindex/client/client.py,sha256=ZOcMY5IjOUxADkCsCdpgylJM-oJVY_XObRVH4p4onVI,15428
+arkindex/client/decoders.py,sha256=WmRdqNAFv884XIfHXTkQoohJMapeTq8AqQzsW26K-t4,7952
+arkindex/schema/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arkindex/schema/openapi.py,sha256=HHAHyUxqa6sK1l8aEy7SHx-9w20Pbov54AB4rHPjguk,9183
+arkindex/schema/validator.py,sha256=Baq2TtqMWZVRU_SYF7aUJ0Y80t-CIboCtK_GV8TPNKE,625
+arkindex_client-1.1.3.dist-info/LICENSE,sha256=s7yDHdG8liSj2PiaVwRi9G5wR1qDXSPmhPJPgWbrkWU,34504
+arkindex_client-1.1.3.dist-info/METADATA,sha256=rOgOnPbp4NP2WnhQMNwx61OIcVQX2nfz-6XrFeO_nQ8,1051
+arkindex_client-1.1.3.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+arkindex_client-1.1.3.dist-info/top_level.txt,sha256=ALyF0lTPpxOheUGmSVwEhgI6eMYwm_9Eu37G-RwGBRM,17
+arkindex_client-1.1.3.dist-info/RECORD,,

{arkindex_client-1.1.1.dist-info → arkindex_client-1.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.44.0)
+Generator: bdist_wheel (0.45.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

arkindex/client/base.py

@@ -1,98 +0,0 @@
-# -*- coding: utf-8 -*-
-from urllib.parse import quote, urljoin, urlparse
-
-import typesystem
-
-from arkindex import exceptions
-from arkindex.client.transports import HTTPTransport
-from arkindex.schema.validator import validate
-
-
-class BaseClient:
-    def __init__(
-        self,
-        schema,
-        encoding=None,
-        auth=None,
-        decoders=None,
-        headers=None,
-        session=None,
-        allow_cookies=True,
-        verify=True,
-    ):
-        self.document = validate(schema, encoding=encoding)
-        self.transport = HTTPTransport(
-            auth=auth,
-            decoders=decoders,
-            headers=headers,
-            session=session,
-            allow_cookies=allow_cookies,
-            verify=verify,
-        )
-
-    def lookup_operation(self, operation_id: str):
-        for item in self.document.walk_links():
-            if item.link.name == operation_id:
-                return item.link
-        text = 'Operation ID "%s" not found in schema.' % operation_id
-        message = exceptions.ErrorMessage(text=text, code="invalid-operation")
-        raise exceptions.ClientError(messages=[message])
-
-    def get_url(self, link, params):
-        url = urljoin(self.document.url, link.url)
-
-        scheme = urlparse(url).scheme.lower()
-
-        if not scheme:
-            text = "URL missing scheme '%s'." % url
-            message = exceptions.ErrorMessage(text=text, code="invalid-url")
-            raise exceptions.ClientError(messages=[message])
-
-        if scheme not in self.transport.schemes:
-            text = "Unsupported URL scheme '%s'." % scheme
-            message = exceptions.ErrorMessage(text=text, code="invalid-url")
-            raise exceptions.ClientError(messages=[message])
-
-        for field in link.get_path_fields():
-            value = str(params[field.name])
-            if "{%s}" % field.name in url:
-                url = url.replace("{%s}" % field.name, quote(value, safe=""))
-            elif "{+%s}" % field.name in url:
-                url = url.replace("{+%s}" % field.name, quote(value, safe="/"))
-
-        return url
-
-    def get_query_params(self, link, params):
-        return {
-            field.name: params[field.name]
-            for field in link.get_query_fields()
-            if field.name in params
-        }
-
-    def get_content_and_encoding(self, link, params):
-        body_field = link.get_body_field()
-        if body_field and body_field.name in params:
-            return (params[body_field.name], link.encoding)
-        return (None, None)
-
-    def request(self, operation_id: str, **params):
-        link = self.lookup_operation(operation_id)
-
-        validator = typesystem.Object(
-            properties={field.name: typesystem.Any() for field in link.fields},
-            required=[field.name for field in link.fields if field.required],
-            additional_properties=False,
-        )
-        try:
-            validator.validate(params)
-        except typesystem.ValidationError as exc:
-            raise exceptions.ClientError(messages=exc.messages()) from None
-
-        method = link.method
-        url = self.get_url(link, params)
-        query_params = self.get_query_params(link, params)
-        (content, encoding) = self.get_content_and_encoding(link, params)
-
-        return self.transport.send(
-            method, url, query_params=query_params, content=content, encoding=encoding
-        )

arkindex/client/transports.py

@@ -1,132 +0,0 @@
-# -*- coding: utf-8 -*-
-import http
-from importlib.metadata import version
-
-import requests
-
-from arkindex import exceptions
-from arkindex.client import decoders
-
-REQUEST_TIMEOUT = (30, 60)
-
-
-class BlockAllCookies(http.cookiejar.CookiePolicy):
-    """
-    A cookie policy that rejects all cookies.
-    Used to override the default `requests` behavior.
-    """
-
-    return_ok = set_ok = domain_return_ok = path_return_ok = (
-        lambda self, *args, **kwargs: False
-    )
-    netscape = True
-    rfc2965 = hide_cookie2 = False
-
-
-class BaseTransport:
-    schemes = None
-
-    def send(self, method, url, query_params=None, content=None, encoding=None):
-        raise NotImplementedError()
-
-
-class HTTPTransport(BaseTransport):
-    schemes = ["http", "https"]
-    default_decoders = [
-        decoders.JSONDecoder(),
-        decoders.TextDecoder(),
-        decoders.DownloadDecoder(),
-    ]
-
-    def __init__(
-        self,
-        auth=None,
-        decoders=None,
-        headers=None,
-        session=None,
-        allow_cookies=True,
-        verify=True,
-    ):
-        if session is None:
-            session = requests.Session()
-        if auth is not None:
-            session.auth = auth
-        if not allow_cookies:
-            session.cookies.set_policy(BlockAllCookies())
-
-        self.session = session
-        self.verify = verify
-        self.decoders = list(decoders) if decoders else list(self.default_decoders)
-
-        client_version = version("arkindex-client")
-        self.headers = {
-            "accept": ", ".join([decoder.media_type for decoder in self.decoders]),
-            "user-agent": f"arkindex-client/{client_version}",
-        }
-        if headers:
-            self.headers.update({key.lower(): value for key, value in headers.items()})
-
-    def send(self, method, url, query_params=None, content=None, encoding=None):
-        options = self.get_request_options(query_params, content, encoding)
-        response = self.session.request(method, url, **options)
-        result = self.decode_response_content(response)
-
-        if 400 <= response.status_code <= 599:
-            title = "%d %s" % (response.status_code, response.reason)
-            raise exceptions.ErrorResponse(
-                title=title, status_code=response.status_code, content=result
-            )
-
-        return result
-
-    def get_decoder(self, content_type=None):
-        """
-        Given the value of a 'Content-Type' header, return the appropriate
-        decoder for handling the response content.
-        """
-        if content_type is None:
-            return self.decoders[0]
-
-        content_type = content_type.split(";")[0].strip().lower()
-        main_type = content_type.split("/")[0] + "/*"
-        wildcard_type = "*/*"
-
-        for codec in self.decoders:
-            if codec.media_type in (content_type, main_type, wildcard_type):
-                return codec
-
-        text = (
-            "Unsupported encoding '%s' in response Content-Type header." % content_type
-        )
-        message = exceptions.ErrorMessage(text=text, code="cannot-decode-response")
-        raise exceptions.ClientError(messages=[message])
-
-    def get_request_options(self, query_params=None, content=None, encoding=None):
-        """
-        Return the 'options' for sending the outgoing request.
-        """
-        options = {
-            "headers": dict(self.headers),
-            "params": query_params,
-            "timeout": REQUEST_TIMEOUT,
-            "verify": self.verify,
-        }
-
-        if content is not None:
-            assert (
-                encoding == "application/json"
-            ), "Only JSON request bodies are supported"
-            options["json"] = content
-
-        return options
-
-    def decode_response_content(self, response):
-        """
-        Given an HTTP response, return the decoded data.
-        """
-        if not response.content:
-            return None
-
-        content_type = response.headers.get("content-type")
-        decoder = self.get_decoder(content_type)
-        return decoder.decode(response)

arkindex/schema/jsonschema.py

@@ -1,66 +0,0 @@
-# -*- coding: utf-8 -*-
-import typesystem
-
-definitions = typesystem.SchemaDefinitions()
-
-JSON_SCHEMA = (
-    typesystem.Object(
-        properties={
-            "$ref": typesystem.String(),
-            "type": typesystem.String() | typesystem.Array(items=typesystem.String()),
-            "enum": typesystem.Array(unique_items=True, min_items=1),
-            "definitions": typesystem.Object(
-                additional_properties=typesystem.Reference(
-                    "JSONSchema", definitions=definitions
-                )
-            ),
-            # String
-            "minLength": typesystem.Integer(minimum=0),
-            "maxLength": typesystem.Integer(minimum=0),
-            "pattern": typesystem.String(format="regex"),
-            "format": typesystem.String(),
-            # Numeric
-            "minimum": typesystem.Number(),
-            "maximum": typesystem.Number(),
-            "exclusiveMinimum": typesystem.Number(),
-            "exclusiveMaximum": typesystem.Number(),
-            "multipleOf": typesystem.Number(exclusive_minimum=0),
-            # Object
-            "properties": typesystem.Object(
-                additional_properties=typesystem.Reference(
-                    "JSONSchema", definitions=definitions
-                )
-            ),
-            "minProperties": typesystem.Integer(minimum=0),
-            "maxProperties": typesystem.Integer(minimum=0),
-            "patternProperties": typesystem.Object(
-                additional_properties=typesystem.Reference(
-                    "JSONSchema", definitions=definitions
-                )
-            ),
-            "additionalProperties": (
-                typesystem.Reference("JSONSchema", definitions=definitions)
-                | typesystem.Boolean()
-            ),
-            "required": typesystem.Array(items=typesystem.String(), unique_items=True),
-            # Array
-            "items": (
-                typesystem.Reference("JSONSchema", definitions=definitions)
-                | typesystem.Array(
-                    items=typesystem.Reference("JSONSchema", definitions=definitions),
-                    min_items=1,
-                )
-            ),
-            "additionalItems": (
-                typesystem.Reference("JSONSchema", definitions=definitions)
-                | typesystem.Boolean()
-            ),
-            "minItems": typesystem.Integer(minimum=0),
-            "maxItems": typesystem.Integer(minimum=0),
-            "uniqueItems": typesystem.Boolean(),
-        }
-    )
-    | typesystem.Boolean()
-)
-
-definitions["JSONSchema"] = JSON_SCHEMA

arkindex_client-1.1.1.dist-info/RECORD

@@ -1,23 +0,0 @@
-apistar/__init__.py,sha256=mX65SD-MGA1ZynGKkqh7zEONxAIMsPktTaAXeh69Kwc,231
-apistar/exceptions.py,sha256=yzjDlUB5o0xaORBabqTXmf4ckYjNHz1ceV8ECg3jDek,328
-arkindex/__init__.py,sha256=OBw25Nwe6r1AN3a36-8lnUcDy3nkDIiebBgYNK2Zo9o,99
-arkindex/auth.py,sha256=OeuzFeCQ8FAt0kqPECjsEz-Ki9__-y69z5sAuyTZ28c,1550
-arkindex/compat.py,sha256=Kjxu--QoF8sBxKOvXMtNcDQ0XK7MLc_2C8Q2knll4Lk,805
-arkindex/document.py,sha256=SUmzvuJpeHlRC4ozqnqsPFpzZ9_Yb9p6vxIZpMjMCSA,6783
-arkindex/exceptions.py,sha256=hDxbgC7uAD8wbTQS1DaEJZ25Nun41Io8Y0BiwrZ1ZSM,2016
-arkindex/mock.py,sha256=olYBFCkLQuuf9gGu7wlmZiLFMQknGGi8evS531RjjUE,2755
-arkindex/pagination.py,sha256=c6dG_OkQDG00ZfGUbHuZxu-UvOpmYf7dJP1ZaUaha1Y,9008
-arkindex/client/__init__.py,sha256=g_G_bSfMbduYzpi9iURTn0cYLV4nMulDR8rD7x-DLyc,142
-arkindex/client/base.py,sha256=vlR5HjaNQ_LzIP_FAzaZbhJSh7VzD9mXc0T8C5FB8EU,3400
-arkindex/client/client.py,sha256=lfHyicizHDxdymPA1hl0kJj7vdrudVvbE2Ei3qtZqQM,12019
-arkindex/client/decoders.py,sha256=F_uBGOrh1BFnZzuW0MTjwm8wAArbybPsrIVol_2vYN0,7886
-arkindex/client/transports.py,sha256=482CHa-8S5p190Z4cX6TiCWgz99enfloT7FCNuS02yY,4055
-arkindex/schema/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arkindex/schema/jsonschema.py,sha256=sJ0OlkowXoE4FnA3r9_QdOmLlDP46K7YPPQm58NkfMo,2572
-arkindex/schema/openapi.py,sha256=bwVAEjdHNUf9iRPVdbQwruivs4GAwbe0db1KkLNKa80,17603
-arkindex/schema/validator.py,sha256=N2sda7vxfivw68VuyX-MfmUlrXjf_LEHNg6OCKc1mjQ,1926
-arkindex_client-1.1.1.dist-info/LICENSE,sha256=s7yDHdG8liSj2PiaVwRi9G5wR1qDXSPmhPJPgWbrkWU,34504
-arkindex_client-1.1.1.dist-info/METADATA,sha256=IzsAvC5p34ps77eNhP8x9s-GSN-_qIp1eSlXemcQJLA,1080
-arkindex_client-1.1.1.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-arkindex_client-1.1.1.dist-info/top_level.txt,sha256=ALyF0lTPpxOheUGmSVwEhgI6eMYwm_9Eu37G-RwGBRM,17
-arkindex_client-1.1.1.dist-info/RECORD,,