Skip to content

Commit

Permalink
feat: type hinting improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
evansims committed Feb 3, 2025
1 parent 8df528d commit 7cc19d1
Show file tree
Hide file tree
Showing 122 changed files with 276 additions and 127 deletions.
1 change: 1 addition & 0 deletions example/example1/example1.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

from dotenv import load_dotenv


sdk_path = os.path.realpath(os.path.join(os.path.abspath(__file__), "..", "..", ".."))
sys.path.insert(0, sdk_path)

Expand Down
1 change: 1 addition & 0 deletions example/example1/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

from setuptools import find_packages, setup


NAME = "example1"
VERSION = "0.0.1"
REQUIRES = ["openfga-sdk >= 0.9.1"]
Expand Down
2 changes: 2 additions & 0 deletions example/opentelemetry/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import asyncio
import os
import sys

from operator import attrgetter
from random import randint
from typing import Any
Expand All @@ -29,6 +30,7 @@
)
from opentelemetry.sdk.resources import SERVICE_NAME, Resource


# For usage convenience of this example, we will import the OpenFGA SDK from the parent directory.
sdk_path = os.path.realpath(os.path.join(os.path.abspath(__file__), "..", "..", ".."))
sys.path.insert(0, sdk_path)
Expand Down
1 change: 1 addition & 0 deletions example/opentelemetry/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

from setuptools import find_packages, setup


NAME = "openfga-opentelemetry-example"
VERSION = "0.0.1"
REQUIRES = [""]
Expand Down
2 changes: 2 additions & 0 deletions example/streamed-list-objects/asynchronous.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@
import json
import os
import sys

from operator import attrgetter
from typing import Any

from dotenv import load_dotenv


sdk_path = os.path.realpath(os.path.join(os.path.abspath(__file__), "..", "..", ".."))
sys.path.insert(0, sdk_path)

Expand Down
1 change: 1 addition & 0 deletions example/streamed-list-objects/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

from setuptools import find_packages, setup


NAME = "openfga-streamed-list-objects-example"
VERSION = "0.0.1"
REQUIRES = [""]
Expand Down
2 changes: 2 additions & 0 deletions example/streamed-list-objects/synchronous.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@
import json
import os
import sys

from operator import attrgetter
from typing import Any

from dotenv import load_dotenv


sdk_path = os.path.realpath(os.path.join(os.path.abspath(__file__), "..", "..", ".."))
sys.path.insert(0, sdk_path)

Expand Down
24 changes: 11 additions & 13 deletions openfga_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,19 @@

__version__ = "0.9.1"

from openfga_sdk.client.client import OpenFgaClient
from openfga_sdk.client.configuration import ClientConfiguration

from openfga_sdk.api.open_fga_api import OpenFgaApi

from openfga_sdk.api_client import ApiClient
from openfga_sdk.client.client import OpenFgaClient
from openfga_sdk.client.configuration import ClientConfiguration
from openfga_sdk.configuration import Configuration

from openfga_sdk.exceptions import OpenApiException
from openfga_sdk.exceptions import FgaValidationException
from openfga_sdk.exceptions import ApiValueError
from openfga_sdk.exceptions import ApiKeyError
from openfga_sdk.exceptions import ApiAttributeError
from openfga_sdk.exceptions import ApiException

from openfga_sdk.exceptions import (
ApiAttributeError,
ApiException,
ApiKeyError,
ApiValueError,
FgaValidationException,
OpenApiException,
)
from openfga_sdk.models.aborted_message_response import AbortedMessageResponse
from openfga_sdk.models.any import Any
from openfga_sdk.models.assertion import Assertion
Expand Down Expand Up @@ -137,7 +135,6 @@
from openfga_sdk.models.write_request import WriteRequest
from openfga_sdk.models.write_request_deletes import WriteRequestDeletes
from openfga_sdk.models.write_request_writes import WriteRequestWrites

from openfga_sdk.telemetry.configuration import (
TelemetryConfiguration,
TelemetryConfigurations,
Expand All @@ -146,6 +143,7 @@
TelemetryMetricsConfiguration,
)


__all__ = [
"OpenFgaClient",
"ClientConfiguration",
Expand Down
5 changes: 4 additions & 1 deletion openfga_sdk/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@
import re
import time
import urllib

from multiprocessing.pool import ThreadPool

from dateutil.parser import parse # type: ignore[import-untyped]

import openfga_sdk.models
from openfga_sdk import rest, oauth2

from openfga_sdk import oauth2, rest
from openfga_sdk.configuration import Configuration
from openfga_sdk.exceptions import (
ApiException,
Expand All @@ -36,6 +38,7 @@
from openfga_sdk.telemetry import Telemetry
from openfga_sdk.telemetry.attributes import TelemetryAttribute, TelemetryAttributes


DEFAULT_USER_AGENT = "openfga-sdk python/0.9.1"


Expand Down
1 change: 1 addition & 0 deletions openfga_sdk/client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from openfga_sdk.client.configuration import ClientConfiguration
from openfga_sdk.client.models.check_request import ClientCheckRequest


__all__ = [
"OpenFgaClient",
"ClientConfiguration",
Expand Down
17 changes: 9 additions & 8 deletions openfga_sdk/client/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
import asyncio
import uuid

from openfga_sdk.api_client import ApiClient
from openfga_sdk.api.open_fga_api import OpenFgaApi
from openfga_sdk.api_client import ApiClient
from openfga_sdk.client.configuration import ClientConfiguration
from openfga_sdk.client.models.assertion import ClientAssertion
from openfga_sdk.client.models.batch_check_item import (
Expand All @@ -26,25 +26,25 @@
from openfga_sdk.client.models.batch_check_single_response import (
ClientBatchCheckSingleResponse,
)
from openfga_sdk.client.models.client_batch_check_response import (
ClientBatchCheckClientResponse,
)
from openfga_sdk.client.models.check_request import (
ClientCheckRequest,
construct_check_request,
)
from openfga_sdk.client.models.tuple import ClientTuple, convert_tuple_keys
from openfga_sdk.client.models.write_request import ClientWriteRequest
from openfga_sdk.client.models.write_response import ClientWriteResponse
from openfga_sdk.client.models.client_batch_check_response import (
ClientBatchCheckClientResponse,
)
from openfga_sdk.client.models.expand_request import ClientExpandRequest
from openfga_sdk.client.models.list_objects_request import ClientListObjectsRequest
from openfga_sdk.client.models.list_relations_request import ClientListRelationsRequest
from openfga_sdk.client.models.list_users_request import ClientListUsersRequest
from openfga_sdk.client.models.read_changes_request import ClientReadChangesRequest
from openfga_sdk.client.models.tuple import ClientTuple, convert_tuple_keys
from openfga_sdk.client.models.write_request import ClientWriteRequest
from openfga_sdk.client.models.write_response import ClientWriteResponse
from openfga_sdk.client.models.write_single_response import (
construct_write_single_response,
)
from openfga_sdk.client.models.write_transaction_opts import WriteTransactionOpts
from openfga_sdk.client.models.read_changes_request import ClientReadChangesRequest
from openfga_sdk.exceptions import (
AuthenticationError,
FgaValidationException,
Expand Down Expand Up @@ -75,6 +75,7 @@
from openfga_sdk.models.write_request import WriteRequest
from openfga_sdk.validation import is_well_formed_ulid_string


CLIENT_METHOD_HEADER = "X-OpenFGA-Client-Method"
CLIENT_BULK_REQUEST_ID_HEADER = "X-OpenFGA-Client-Bulk-Request-Id"

Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/client/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
from openfga_sdk.client.models.batch_check_single_response import (
ClientBatchCheckSingleResponse,
)
from openfga_sdk.client.models.check_request import ClientCheckRequest
from openfga_sdk.client.models.client_batch_check_response import (
ClientBatchCheckClientResponse,
)
from openfga_sdk.client.models.check_request import ClientCheckRequest
from openfga_sdk.client.models.expand_request import ClientExpandRequest
from openfga_sdk.client.models.list_objects_request import ClientListObjectsRequest
from openfga_sdk.client.models.list_relations_request import ClientListRelationsRequest
Expand All @@ -30,6 +30,7 @@
from openfga_sdk.client.models.write_response import ClientWriteResponse
from openfga_sdk.client.models.write_transaction_opts import WriteTransactionOpts


__all__ = [
"ClientAssertion",
"ClientBatchCheckItem",
Expand Down
2 changes: 1 addition & 1 deletion openfga_sdk/client/models/write_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
"""

from openfga_sdk.client.models.tuple import ClientTuple, convert_tuple_keys
from openfga_sdk.models.write_request_writes import WriteRequestWrites
from openfga_sdk.models.write_request_deletes import WriteRequestDeletes
from openfga_sdk.models.write_request_writes import WriteRequestWrites


class ClientWriteRequest:
Expand Down
5 changes: 3 additions & 2 deletions openfga_sdk/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@
"""

import copy
import http
import logging
import sys
import http
import urllib

import urllib3

from openfga_sdk.exceptions import FgaValidationException, ApiValueError
from openfga_sdk.exceptions import ApiValueError, FgaValidationException
from openfga_sdk.telemetry.attributes import TelemetryAttribute
from openfga_sdk.telemetry.configuration import (
TelemetryConfiguration,
Expand Down
1 change: 1 addition & 0 deletions openfga_sdk/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@
from openfga_sdk.models.write_request_deletes import WriteRequestDeletes
from openfga_sdk.models.write_request_writes import WriteRequestWrites


__all__ = [
"AbortedMessageResponse",
"Any",
Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/aborted_message_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/any.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/assertion.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/assertion_tuple_key.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/auth_error_code.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/authorization_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/batch_check_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/batch_check_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/batch_check_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/batch_check_single_result.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
3 changes: 2 additions & 1 deletion openfga_sdk/models/check_error.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
"""

from inspect import getfullargspec
import pprint

from inspect import getfullargspec

from openfga_sdk.configuration import Configuration


Expand Down
Loading

0 comments on commit 7cc19d1

Please sign in to comment.