:py:mod:`datatypes.models` ========================== .. py:module:: datatypes.models .. autoapi-nested-parse:: Module that contains the database models and return types Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: datatypes.models.StringFields datatypes.models.UserBase datatypes.models.UserCreate datatypes.models.User datatypes.models.SysPermissions datatypes.models.SystemPermission datatypes.models.Project datatypes.models.ProjPermissions datatypes.models.ProjectPermission datatypes.models.Document datatypes.models.Patch datatypes.models.DocPermissions datatypes.models.DocumentPermission datatypes.models.Process datatypes.models.DocumentRole datatypes.models.DocumentProcess datatypes.models.MSProject datatypes.models.MSProjectField datatypes.models.MSProjectComputedField datatypes.models.ComputedField datatypes.models.PatchReturn datatypes.models.ComputedFieldReturn datatypes.models.MSComputedFieldReturn datatypes.models.DocumentReturn datatypes.models.ProjectReturn datatypes.models.ProjectPermissionsInput datatypes.models.DocumentPermissionsInput .. py:class:: StringFields Bases: :py:obj:`type` Helper class that prepends the table name to the fields .. py:method:: __getattribute__(self, item) Return getattr(self, name). .. py:class:: UserBase(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:attribute:: user_name :annotation: :str .. py:class:: UserCreate(__pydantic_self__, **data) Bases: :py:obj:`UserBase` .. py:attribute:: password :annotation: :str .. py:class:: User(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = user .. py:attribute:: user_name :annotation: = user_name .. py:attribute:: password :annotation: = password .. py:attribute:: user_name :annotation: :str .. py:attribute:: password :annotation: :str .. py:attribute:: system_permissions :annotation: :List[SystemPermission] .. py:attribute:: project_permissions :annotation: :List[ProjectPermission] .. py:attribute:: documents_permissions :annotation: :List[DocumentPermission] .. py:attribute:: owned_projects :annotation: :List[Project] .. py:class:: SysPermissions Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'. .. py:attribute:: create_projects :annotation: = create_projects .. py:attribute:: view_projects :annotation: = view_projects .. py:attribute:: edit_projects :annotation: = edit_projects .. py:attribute:: delete_projects :annotation: = delete_projects .. py:attribute:: view_users :annotation: = view_users .. py:attribute:: edit_users :annotation: = edit_users .. py:attribute:: delete_users :annotation: = delete_users .. py:attribute:: edit_users_permissions :annotation: = edit_users_permissions .. py:attribute:: edit_projects_permissions :annotation: = edit_projects_permissions .. py:class:: SystemPermission(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = systempermission .. py:attribute:: user_name :annotation: = user_name .. py:attribute:: permission :annotation: = permission .. py:attribute:: user_name :annotation: :str .. py:attribute:: permission :annotation: :SysPermissions .. py:attribute:: user :annotation: :User .. py:class:: Project(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = project .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: owner_name :annotation: = owner_name .. py:attribute:: project_name :annotation: :str .. py:attribute:: owner_name :annotation: :str .. py:attribute:: owner :annotation: :User .. py:attribute:: documents :annotation: :List[Document] .. py:attribute:: users_permissions :annotation: :List[ProjectPermission] .. py:attribute:: processes :annotation: :List[Process] .. py:class:: ProjPermissions Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'. .. py:attribute:: view :annotation: = view .. py:attribute:: edit :annotation: = edit .. py:attribute:: delete :annotation: = delete .. py:attribute:: create_documents :annotation: = create_documents .. py:attribute:: view_documents :annotation: = view_documents .. py:attribute:: edit_documents :annotation: = edit_documents .. py:attribute:: delete_documents :annotation: = delete_documents .. py:attribute:: edit_project_permissions :annotation: = edit_project_permissions .. py:attribute:: edit_documents_permissions :annotation: = edit_documents_permissions .. py:class:: ProjectPermission(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = projectpermission .. py:attribute:: user_name :annotation: = user_name .. py:attribute:: permission :annotation: = permission .. py:attribute:: user_name :annotation: :str .. py:attribute:: project_name :annotation: :str .. py:attribute:: permission :annotation: :ProjPermissions .. py:attribute:: user :annotation: :User .. py:attribute:: project :annotation: :Project .. py:class:: Document(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = document .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: document_name :annotation: = document_name .. py:attribute:: author_name :annotation: = author_name .. py:attribute:: jsonschema :annotation: = jsonschema .. py:attribute:: first :annotation: = first .. py:attribute:: last :annotation: = last .. py:attribute:: schema_add_date :annotation: = schema_add_date .. py:attribute:: creation_date :annotation: = creation_date .. py:attribute:: updated_date :annotation: = updated_date .. py:class:: Config .. py:attribute:: arbitrary_types_allowed :annotation: = True .. py:attribute:: project_name :annotation: :str .. py:attribute:: document_name :annotation: :str .. py:attribute:: author_name :annotation: :str .. py:attribute:: jsonschema :annotation: :Dict .. py:attribute:: first :annotation: :Dict .. py:attribute:: last :annotation: :Dict .. py:attribute:: schema_add_date :annotation: :datetime.datetime .. py:attribute:: creation_date :annotation: :datetime | None .. py:attribute:: updated_date :annotation: :datetime | None .. py:attribute:: patches :annotation: :List[Patch] .. py:attribute:: project :annotation: :Project .. py:attribute:: permissions :annotation: :List[DocumentPermission] .. py:attribute:: documents_processes :annotation: :List[DocumentProcess] .. py:attribute:: computed_fields :annotation: :List[ComputedField] .. py:attribute:: computed_fields_reference :annotation: :List[ComputedField] .. py:attribute:: ms_computed_fields :annotation: :List[MSProjectComputedField] .. py:class:: Patch(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = patch .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: document_name :annotation: = document_name .. py:attribute:: user_name :annotation: = user_name .. py:attribute:: updated_date :annotation: = updated_date .. py:attribute:: patch :annotation: = patch .. py:class:: Config .. py:attribute:: arbitrary_types_allowed :annotation: = True .. py:attribute:: id :annotation: :int | None .. py:attribute:: project_name :annotation: :str .. py:attribute:: document_name :annotation: :str .. py:attribute:: user_name :annotation: :str .. py:attribute:: updated_date :annotation: :datetime.datetime .. py:attribute:: patch :annotation: :List[Dict] .. py:attribute:: document :annotation: :Document .. py:class:: DocPermissions Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'. .. py:attribute:: view :annotation: = view .. py:attribute:: edit :annotation: = edit .. py:attribute:: delete :annotation: = delete .. py:attribute:: edit_permissions :annotation: = edit_permissions .. py:class:: DocumentPermission(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = documentpermission .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: document_name :annotation: = document_name .. py:attribute:: user_name :annotation: = user_name .. py:attribute:: permission :annotation: = permission .. py:attribute:: project_name :annotation: :str .. py:attribute:: document_name :annotation: :str | None .. py:attribute:: user_name :annotation: :str .. py:attribute:: permission :annotation: :DocPermissions .. py:attribute:: user :annotation: :User .. py:attribute:: document :annotation: :Document .. py:class:: Process(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = process .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: process_name :annotation: = process_name .. py:attribute:: project_name :annotation: :str .. py:attribute:: process_name :annotation: :str .. py:attribute:: project :annotation: :Project .. py:attribute:: documents_processes :annotation: :List[DocumentProcess] .. py:class:: DocumentRole Bases: :py:obj:`int`, :py:obj:`enum.Enum` int([x]) -> integer int(x, base=10) -> integer Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.__int__(). For floating point numbers, this truncates towards zero. If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal. >>> int('0b100', base=0) 4 .. py:attribute:: input :annotation: = 1 .. py:attribute:: output :annotation: = 2 .. py:class:: DocumentProcess(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = documentprocess .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: process_name :annotation: = process_name .. py:attribute:: document_name :annotation: = document_name .. py:attribute:: document_role :annotation: = document_role .. py:attribute:: project_name :annotation: :str .. py:attribute:: process_name :annotation: :str .. py:attribute:: document_name :annotation: :str .. py:attribute:: document_role :annotation: :DocumentRole .. py:attribute:: document :annotation: :Document .. py:attribute:: process :annotation: :Process .. py:class:: MSProject(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = msproject .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: ms_project_name :annotation: = ms_project_name .. py:attribute:: tasks :annotation: = tasks .. py:attribute:: resources :annotation: = resources .. py:attribute:: project_name :annotation: :str .. py:attribute:: author_name :annotation: :str .. py:attribute:: update_author_name :annotation: :str .. py:attribute:: ms_project_name :annotation: :str .. py:attribute:: tasks :annotation: :List[Dict] .. py:attribute:: resources :annotation: :List[Dict] .. py:attribute:: computed_fields_reference :annotation: :List[MSProjectComputedField] .. py:class:: MSProjectField Bases: :py:obj:`enum.Enum` Generic enumeration. Derive from this class to define new enumerations. .. py:attribute:: tasks :annotation: = tasks .. py:attribute:: resources :annotation: = resources .. py:class:: MSProjectComputedField(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = msprojectcomputedfield .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: ms_project_name :annotation: = ms_project_name .. py:attribute:: field_document_name :annotation: = field_document_name .. py:attribute:: field_name :annotation: = field_name .. py:attribute:: jsonpath :annotation: = jsonpath .. py:attribute:: field_value :annotation: = field_value .. py:attribute:: field_from :annotation: = field_from .. py:attribute:: project_name :annotation: :str .. py:attribute:: ms_project_name :annotation: :str .. py:attribute:: field_document_name :annotation: :str .. py:attribute:: field_name :annotation: :str .. py:attribute:: jsonpath :annotation: :str .. py:attribute:: field_value :annotation: :List | None .. py:attribute:: field_from :annotation: :str .. py:attribute:: field_document :annotation: :Document .. py:attribute:: ms_project :annotation: :MSProject .. py:class:: ComputedField(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Fields .. py:attribute:: table_name :annotation: = computedfield .. py:attribute:: project_name :annotation: = project_name .. py:attribute:: field_document_name :annotation: = field_document_name .. py:attribute:: reference_document_name :annotation: = reference_document_name .. py:attribute:: field_name :annotation: = field_name .. py:attribute:: jsonpath :annotation: = jsonpath .. py:attribute:: field_value :annotation: = field_value .. py:attribute:: project_name :annotation: :str .. py:attribute:: field_document_name :annotation: :str .. py:attribute:: reference_document_name :annotation: :str .. py:attribute:: field_name :annotation: :str .. py:attribute:: jsonpath :annotation: :str .. py:attribute:: field_value :annotation: :List | None .. py:attribute:: field_document :annotation: :Document .. py:attribute:: reference_document :annotation: :Document .. py:class:: PatchReturn(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Config .. py:attribute:: arbitrary_types_allowed :annotation: = True .. py:attribute:: id :annotation: :int | None .. py:attribute:: user_name :annotation: :str | None .. py:attribute:: updated_date :annotation: :datetime | None .. py:attribute:: patch :annotation: :List[Dict] = [] .. py:class:: ComputedFieldReturn(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:attribute:: field_name :annotation: :str | None .. py:attribute:: field_value :annotation: :List | None .. py:class:: MSComputedFieldReturn(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:attribute:: field_name :annotation: :str | None .. py:attribute:: field_value :annotation: :List | None .. py:class:: DocumentReturn(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:class:: Config .. py:attribute:: arbitrary_types_allowed :annotation: = True .. py:attribute:: project_name :annotation: :str | None .. py:attribute:: document_name :annotation: :str | None .. py:attribute:: author_name :annotation: :str | None .. py:attribute:: jsonschema :annotation: :Dict | None .. py:attribute:: first :annotation: :Dict | None .. py:attribute:: last :annotation: :Dict | None .. py:attribute:: creation_date :annotation: :datetime | None .. py:attribute:: patches :annotation: :List[PatchReturn] = [] .. py:attribute:: computed_fields :annotation: :List[ComputedFieldReturn] = [] .. py:attribute:: ms_computed_fields :annotation: :List[MSComputedFieldReturn] = [] .. py:method:: transform_comp_fields(cls, v) .. py:method:: transform_ms_comp_fields(cls, v) .. py:class:: ProjectReturn(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:attribute:: project_name :annotation: :str | None .. py:attribute:: owner_name :annotation: :str | None .. py:attribute:: documents :annotation: :List[DocumentReturn] = [] .. py:class:: ProjectPermissionsInput(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:attribute:: user_name :annotation: :str .. py:attribute:: permissions :annotation: :List[ProjPermissions] = [] .. py:class:: DocumentPermissionsInput(__pydantic_self__, **data) Bases: :py:obj:`sqlmodel.SQLModel` .. py:attribute:: user_name :annotation: :str .. py:attribute:: permissions :annotation: :List[DocPermissions] = []