github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/python-legacy/lakefs_client/model/setup.py (about)

     1  """
     2      lakeFS API
     3  
     4      lakeFS HTTP API  # noqa: E501
     5  
     6      The version of the OpenAPI document: 1.0.0
     7      Contact: services@treeverse.io
     8      Generated by: https://openapi-generator.tech
     9  """
    10  
    11  
    12  import re  # noqa: F401
    13  import sys  # noqa: F401
    14  
    15  from lakefs_client.model_utils import (  # noqa: F401
    16      ApiTypeError,
    17      ModelComposed,
    18      ModelNormal,
    19      ModelSimple,
    20      cached_property,
    21      change_keys_js_to_python,
    22      convert_js_args_to_python_args,
    23      date,
    24      datetime,
    25      file_type,
    26      none_type,
    27      validate_get_composed_info,
    28  )
    29  from ..model_utils import OpenApiModel
    30  from lakefs_client.exceptions import ApiAttributeError
    31  
    32  
    33  def lazy_import():
    34      from lakefs_client.model.access_key_credentials import AccessKeyCredentials
    35      globals()['AccessKeyCredentials'] = AccessKeyCredentials
    36  
    37  
    38  class Setup(ModelNormal):
    39      """NOTE: This class is auto generated by OpenAPI Generator.
    40      Ref: https://openapi-generator.tech
    41  
    42      Do not edit the class manually.
    43  
    44      Attributes:
    45        allowed_values (dict): The key is the tuple path to the attribute
    46            and the for var_name this is (var_name,). The value is a dict
    47            with a capitalized key describing the allowed value and an allowed
    48            value. These dicts store the allowed enum values.
    49        attribute_map (dict): The key is attribute name
    50            and the value is json key in definition.
    51        discriminator_value_class_map (dict): A dict to go from the discriminator
    52            variable value to the discriminator class name.
    53        validations (dict): The key is the tuple path to the attribute
    54            and the for var_name this is (var_name,). The value is a dict
    55            that stores validations for max_length, min_length, max_items,
    56            min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
    57            inclusive_minimum, and regex.
    58        additional_properties_type (tuple): A tuple of classes accepted
    59            as additional properties values.
    60      """
    61  
    62      allowed_values = {
    63      }
    64  
    65      validations = {
    66      }
    67  
    68      @cached_property
    69      def additional_properties_type():
    70          """
    71          This must be a method because a model may have properties that are
    72          of type self, this must run after the class is loaded
    73          """
    74          lazy_import()
    75          return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
    76  
    77      _nullable = False
    78  
    79      @cached_property
    80      def openapi_types():
    81          """
    82          This must be a method because a model may have properties that are
    83          of type self, this must run after the class is loaded
    84  
    85          Returns
    86              openapi_types (dict): The key is attribute name
    87                  and the value is attribute type.
    88          """
    89          lazy_import()
    90          return {
    91              'username': (str,),  # noqa: E501
    92              'key': (AccessKeyCredentials,),  # noqa: E501
    93          }
    94  
    95      @cached_property
    96      def discriminator():
    97          return None
    98  
    99  
   100      attribute_map = {
   101          'username': 'username',  # noqa: E501
   102          'key': 'key',  # noqa: E501
   103      }
   104  
   105      read_only_vars = {
   106      }
   107  
   108      _composed_schemas = {}
   109  
   110      @classmethod
   111      @convert_js_args_to_python_args
   112      def _from_openapi_data(cls, username, *args, **kwargs):  # noqa: E501
   113          """Setup - a model defined in OpenAPI
   114  
   115          Args:
   116              username (str): an identifier for the user (e.g. jane.doe)
   117  
   118          Keyword Args:
   119              _check_type (bool): if True, values for parameters in openapi_types
   120                                  will be type checked and a TypeError will be
   121                                  raised if the wrong type is input.
   122                                  Defaults to True
   123              _path_to_item (tuple/list): This is a list of keys or values to
   124                                  drill down to the model in received_data
   125                                  when deserializing a response
   126              _spec_property_naming (bool): True if the variable names in the input data
   127                                  are serialized names, as specified in the OpenAPI document.
   128                                  False if the variable names in the input data
   129                                  are pythonic names, e.g. snake case (default)
   130              _configuration (Configuration): the instance to use when
   131                                  deserializing a file_type parameter.
   132                                  If passed, type conversion is attempted
   133                                  If omitted no type conversion is done.
   134              _visited_composed_classes (tuple): This stores a tuple of
   135                                  classes that we have traveled through so that
   136                                  if we see that class again we will not use its
   137                                  discriminator again.
   138                                  When traveling through a discriminator, the
   139                                  composed schema that is
   140                                  is traveled through is added to this set.
   141                                  For example if Animal has a discriminator
   142                                  petType and we pass in "Dog", and the class Dog
   143                                  allOf includes Animal, we move through Animal
   144                                  once using the discriminator, and pick Dog.
   145                                  Then in Dog, we will make an instance of the
   146                                  Animal class but this time we won't travel
   147                                  through its discriminator because we passed in
   148                                  _visited_composed_classes = (Animal,)
   149              key (AccessKeyCredentials): [optional]  # noqa: E501
   150          """
   151  
   152          _check_type = kwargs.pop('_check_type', True)
   153          _spec_property_naming = kwargs.pop('_spec_property_naming', False)
   154          _path_to_item = kwargs.pop('_path_to_item', ())
   155          _configuration = kwargs.pop('_configuration', None)
   156          _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
   157  
   158          self = super(OpenApiModel, cls).__new__(cls)
   159  
   160          if args:
   161              raise ApiTypeError(
   162                  "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
   163                      args,
   164                      self.__class__.__name__,
   165                  ),
   166                  path_to_item=_path_to_item,
   167                  valid_classes=(self.__class__,),
   168              )
   169  
   170          self._data_store = {}
   171          self._check_type = _check_type
   172          self._spec_property_naming = _spec_property_naming
   173          self._path_to_item = _path_to_item
   174          self._configuration = _configuration
   175          self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
   176  
   177          self.username = username
   178          for var_name, var_value in kwargs.items():
   179              if var_name not in self.attribute_map and \
   180                          self._configuration is not None and \
   181                          self._configuration.discard_unknown_keys and \
   182                          self.additional_properties_type is None:
   183                  # discard variable.
   184                  continue
   185              setattr(self, var_name, var_value)
   186          return self
   187  
   188      required_properties = set([
   189          '_data_store',
   190          '_check_type',
   191          '_spec_property_naming',
   192          '_path_to_item',
   193          '_configuration',
   194          '_visited_composed_classes',
   195      ])
   196  
   197      @convert_js_args_to_python_args
   198      def __init__(self, username, *args, **kwargs):  # noqa: E501
   199          """Setup - a model defined in OpenAPI
   200  
   201          Args:
   202              username (str): an identifier for the user (e.g. jane.doe)
   203  
   204          Keyword Args:
   205              _check_type (bool): if True, values for parameters in openapi_types
   206                                  will be type checked and a TypeError will be
   207                                  raised if the wrong type is input.
   208                                  Defaults to True
   209              _path_to_item (tuple/list): This is a list of keys or values to
   210                                  drill down to the model in received_data
   211                                  when deserializing a response
   212              _spec_property_naming (bool): True if the variable names in the input data
   213                                  are serialized names, as specified in the OpenAPI document.
   214                                  False if the variable names in the input data
   215                                  are pythonic names, e.g. snake case (default)
   216              _configuration (Configuration): the instance to use when
   217                                  deserializing a file_type parameter.
   218                                  If passed, type conversion is attempted
   219                                  If omitted no type conversion is done.
   220              _visited_composed_classes (tuple): This stores a tuple of
   221                                  classes that we have traveled through so that
   222                                  if we see that class again we will not use its
   223                                  discriminator again.
   224                                  When traveling through a discriminator, the
   225                                  composed schema that is
   226                                  is traveled through is added to this set.
   227                                  For example if Animal has a discriminator
   228                                  petType and we pass in "Dog", and the class Dog
   229                                  allOf includes Animal, we move through Animal
   230                                  once using the discriminator, and pick Dog.
   231                                  Then in Dog, we will make an instance of the
   232                                  Animal class but this time we won't travel
   233                                  through its discriminator because we passed in
   234                                  _visited_composed_classes = (Animal,)
   235              key (AccessKeyCredentials): [optional]  # noqa: E501
   236          """
   237  
   238          _check_type = kwargs.pop('_check_type', True)
   239          _spec_property_naming = kwargs.pop('_spec_property_naming', False)
   240          _path_to_item = kwargs.pop('_path_to_item', ())
   241          _configuration = kwargs.pop('_configuration', None)
   242          _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
   243  
   244          if args:
   245              raise ApiTypeError(
   246                  "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
   247                      args,
   248                      self.__class__.__name__,
   249                  ),
   250                  path_to_item=_path_to_item,
   251                  valid_classes=(self.__class__,),
   252              )
   253  
   254          self._data_store = {}
   255          self._check_type = _check_type
   256          self._spec_property_naming = _spec_property_naming
   257          self._path_to_item = _path_to_item
   258          self._configuration = _configuration
   259          self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
   260  
   261          self.username = username
   262          for var_name, var_value in kwargs.items():
   263              if var_name not in self.attribute_map and \
   264                          self._configuration is not None and \
   265                          self._configuration.discard_unknown_keys and \
   266                          self.additional_properties_type is None:
   267                  # discard variable.
   268                  continue
   269              setattr(self, var_name, var_value)
   270              if var_name in self.read_only_vars:
   271                  raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
   272                                       f"class with read only attributes.")