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