github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/python-legacy/lakefs_client/model/commit_creation.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 CommitCreation(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              'message': (str,),  # noqa: E501
    86              'metadata': ({str: (str,)},),  # noqa: E501
    87              'date': (int,),  # noqa: E501
    88              'allow_empty': (bool,),  # noqa: E501
    89              'force': (bool,),  # noqa: E501
    90          }
    91  
    92      @cached_property
    93      def discriminator():
    94          return None
    95  
    96  
    97      attribute_map = {
    98          'message': 'message',  # noqa: E501
    99          'metadata': 'metadata',  # noqa: E501
   100          'date': 'date',  # noqa: E501
   101          'allow_empty': 'allow_empty',  # noqa: E501
   102          'force': 'force',  # 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, message, *args, **kwargs):  # noqa: E501
   113          """CommitCreation - a model defined in OpenAPI
   114  
   115          Args:
   116              message (str):
   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              metadata ({str: (str,)}): [optional]  # noqa: E501
   150              date (int): set date to override creation date in the commit (Unix Epoch in seconds). [optional]  # noqa: E501
   151              allow_empty (bool): sets whether a commit can contain no changes. [optional] if omitted the server will use the default value of False  # noqa: E501
   152              force (bool): [optional] if omitted the server will use the default value of False  # noqa: E501
   153          """
   154  
   155          _check_type = kwargs.pop('_check_type', True)
   156          _spec_property_naming = kwargs.pop('_spec_property_naming', False)
   157          _path_to_item = kwargs.pop('_path_to_item', ())
   158          _configuration = kwargs.pop('_configuration', None)
   159          _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
   160  
   161          self = super(OpenApiModel, cls).__new__(cls)
   162  
   163          if args:
   164              raise ApiTypeError(
   165                  "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
   166                      args,
   167                      self.__class__.__name__,
   168                  ),
   169                  path_to_item=_path_to_item,
   170                  valid_classes=(self.__class__,),
   171              )
   172  
   173          self._data_store = {}
   174          self._check_type = _check_type
   175          self._spec_property_naming = _spec_property_naming
   176          self._path_to_item = _path_to_item
   177          self._configuration = _configuration
   178          self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
   179  
   180          self.message = message
   181          for var_name, var_value in kwargs.items():
   182              if var_name not in self.attribute_map and \
   183                          self._configuration is not None and \
   184                          self._configuration.discard_unknown_keys and \
   185                          self.additional_properties_type is None:
   186                  # discard variable.
   187                  continue
   188              setattr(self, var_name, var_value)
   189          return self
   190  
   191      required_properties = set([
   192          '_data_store',
   193          '_check_type',
   194          '_spec_property_naming',
   195          '_path_to_item',
   196          '_configuration',
   197          '_visited_composed_classes',
   198      ])
   199  
   200      @convert_js_args_to_python_args
   201      def __init__(self, message, *args, **kwargs):  # noqa: E501
   202          """CommitCreation - a model defined in OpenAPI
   203  
   204          Args:
   205              message (str):
   206  
   207          Keyword Args:
   208              _check_type (bool): if True, values for parameters in openapi_types
   209                                  will be type checked and a TypeError will be
   210                                  raised if the wrong type is input.
   211                                  Defaults to True
   212              _path_to_item (tuple/list): This is a list of keys or values to
   213                                  drill down to the model in received_data
   214                                  when deserializing a response
   215              _spec_property_naming (bool): True if the variable names in the input data
   216                                  are serialized names, as specified in the OpenAPI document.
   217                                  False if the variable names in the input data
   218                                  are pythonic names, e.g. snake case (default)
   219              _configuration (Configuration): the instance to use when
   220                                  deserializing a file_type parameter.
   221                                  If passed, type conversion is attempted
   222                                  If omitted no type conversion is done.
   223              _visited_composed_classes (tuple): This stores a tuple of
   224                                  classes that we have traveled through so that
   225                                  if we see that class again we will not use its
   226                                  discriminator again.
   227                                  When traveling through a discriminator, the
   228                                  composed schema that is
   229                                  is traveled through is added to this set.
   230                                  For example if Animal has a discriminator
   231                                  petType and we pass in "Dog", and the class Dog
   232                                  allOf includes Animal, we move through Animal
   233                                  once using the discriminator, and pick Dog.
   234                                  Then in Dog, we will make an instance of the
   235                                  Animal class but this time we won't travel
   236                                  through its discriminator because we passed in
   237                                  _visited_composed_classes = (Animal,)
   238              metadata ({str: (str,)}): [optional]  # noqa: E501
   239              date (int): set date to override creation date in the commit (Unix Epoch in seconds). [optional]  # noqa: E501
   240              allow_empty (bool): sets whether a commit can contain no changes. [optional] if omitted the server will use the default value of False  # noqa: E501
   241              force (bool): [optional] if omitted the server will use the default value of False  # noqa: E501
   242          """
   243  
   244          _check_type = kwargs.pop('_check_type', True)
   245          _spec_property_naming = kwargs.pop('_spec_property_naming', False)
   246          _path_to_item = kwargs.pop('_path_to_item', ())
   247          _configuration = kwargs.pop('_configuration', None)
   248          _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
   249  
   250          if args:
   251              raise ApiTypeError(
   252                  "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
   253                      args,
   254                      self.__class__.__name__,
   255                  ),
   256                  path_to_item=_path_to_item,
   257                  valid_classes=(self.__class__,),
   258              )
   259  
   260          self._data_store = {}
   261          self._check_type = _check_type
   262          self._spec_property_naming = _spec_property_naming
   263          self._path_to_item = _path_to_item
   264          self._configuration = _configuration
   265          self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
   266  
   267          self.message = message
   268          for var_name, var_value in kwargs.items():
   269              if var_name not in self.attribute_map and \
   270                          self._configuration is not None and \
   271                          self._configuration.discard_unknown_keys and \
   272                          self.additional_properties_type is None:
   273                  # discard variable.
   274                  continue
   275              setattr(self, var_name, var_value)
   276              if var_name in self.read_only_vars:
   277                  raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
   278                                       f"class with read only attributes.")