Models
materia.models
¶
auth
¶
access_token
¶
oauth2
¶
OAuth2Application
¶
Bases: Base
user_id
class-attribute
instance-attribute
¶
user_id = mapped_column(
ForeignKey("user.id", ondelete="CASCADE")
)
confidential_client
class-attribute
instance-attribute
¶
confidential_client = mapped_column(default=True)
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
contains_redirect_uri
¶
contains_redirect_uri(uri)
PARAMETER | DESCRIPTION |
---|---|
uri |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
32 33 34 35 36 37 38 39 40 41 |
|
generate_client_secret
async
¶
generate_client_secret(db)
PARAMETER | DESCRIPTION |
---|---|
db |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
43 44 45 46 47 48 49 50 51 52 53 |
|
validate_client_secret
¶
validate_client_secret(secret)
PARAMETER | DESCRIPTION |
---|---|
secret |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
55 56 |
|
update
async
staticmethod
¶
update(db, app)
PARAMETER | DESCRIPTION |
---|---|
db |
TYPE:
|
app |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
58 59 60 61 62 |
|
delete
async
staticmethod
¶
delete(db, id, user_id)
PARAMETER | DESCRIPTION |
---|---|
db |
TYPE:
|
id |
TYPE:
|
user_id |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
|
by_client_id
async
staticmethod
¶
by_client_id(client_id, db)
PARAMETER | DESCRIPTION |
---|---|
client_id |
TYPE:
|
db |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
84 85 86 87 88 89 90 91 |
|
grant_by_user_id
async
¶
grant_by_user_id(user_id, db)
PARAMETER | DESCRIPTION |
---|---|
user_id |
TYPE:
|
db |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
|
OAuth2AuthorizationCode
¶
Bases: BaseModel
generate_redirect_uri
¶
generate_redirect_uri(state=None)
PARAMETER | DESCRIPTION |
---|---|
state |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
116 117 118 119 120 121 122 123 124 |
|
OAuth2Grant
¶
Bases: Base
user_id
class-attribute
instance-attribute
¶
user_id = mapped_column(
ForeignKey("user.id", ondelete="CASCADE")
)
application_id
class-attribute
instance-attribute
¶
application_id = mapped_column(
ForeignKey("oauth2_application.id", ondelete="CASCADE")
)
application
class-attribute
instance-attribute
¶
application = relationship(back_populates='grants')
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
generate_authorization_code
async
¶
generate_authorization_code(redirect_uri, cache)
PARAMETER | DESCRIPTION |
---|---|
redirect_uri |
TYPE:
|
cache |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
|
scope_contains
¶
scope_contains(scope)
PARAMETER | DESCRIPTION |
---|---|
scope |
TYPE:
|
Source code in src/materia/models/auth/oauth2.py
161 162 |
|
source
¶
LoginType
¶
LoginSource
¶
Bases: Base
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
is_plain
¶
is_plain()
Source code in src/materia/models/auth/source.py
24 25 |
|
is_oauth2
¶
is_oauth2()
Source code in src/materia/models/auth/source.py
27 28 |
|
is_smtp
¶
is_smtp()
Source code in src/materia/models/auth/source.py
30 31 |
|
base
¶
Base
¶
Bases: DeclarativeBase
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
directory
¶
DirectoryError
¶
Bases: Exception
Directory
¶
Bases: Base
repository_id
class-attribute
instance-attribute
¶
repository_id = mapped_column(
ForeignKey("repository.id", ondelete="CASCADE")
)
parent_id
class-attribute
instance-attribute
¶
parent_id = mapped_column(
ForeignKey("directory.id", ondelete="CASCADE"),
nullable=True,
)
created
class-attribute
instance-attribute
¶
created = mapped_column(
BigInteger, nullable=False, default=time
)
updated
class-attribute
instance-attribute
¶
updated = mapped_column(
BigInteger, nullable=False, default=time
)
repository
class-attribute
instance-attribute
¶
repository = relationship(back_populates='directories')
directories
class-attribute
instance-attribute
¶
directories = relationship(back_populates='parent')
parent
class-attribute
instance-attribute
¶
parent = relationship(
back_populates="directories", remote_side=[id]
)
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
new
async
¶
new(session, config)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/directory.py
41 42 43 44 45 46 47 48 49 50 51 52 |
|
remove
async
¶
remove(session, config)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/directory.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
|
relative_path
async
¶
relative_path(session)
Get path of the directory relative repository root.
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/directory.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
|
real_path
async
¶
real_path(session, config)
Get absolute path of the directory
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/directory.py
109 110 111 112 113 114 115 116 117 118 119 |
|
is_root
¶
is_root()
Source code in src/materia/models/directory.py
121 122 |
|
by_path
async
staticmethod
¶
by_path(repository, path, session, config)
PARAMETER | DESCRIPTION |
---|---|
repository |
TYPE:
|
path |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/directory.py
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
|
copy
async
¶
copy(target, session, config, force=False, shallow=False)
PARAMETER | DESCRIPTION |
---|---|
target |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
force |
TYPE:
|
shallow |
TYPE:
|
Source code in src/materia/models/directory.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
|
move
async
¶
move(target, session, config, force=False, shallow=False)
PARAMETER | DESCRIPTION |
---|---|
target |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
force |
TYPE:
|
shallow |
TYPE:
|
Source code in src/materia/models/directory.py
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
|
rename
async
¶
rename(name, session, config, force=False, shallow=False)
PARAMETER | DESCRIPTION |
---|---|
name |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
force |
TYPE:
|
shallow |
TYPE:
|
Source code in src/materia/models/directory.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
|
info
async
¶
info(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/directory.py
245 246 247 248 249 250 251 252 253 254 255 256 |
|
DirectoryLink
¶
Bases: Base
directory_id
class-attribute
instance-attribute
¶
directory_id = mapped_column(
ForeignKey("directory.id", ondelete="CASCADE")
)
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
DirectoryInfo
¶
Bases: BaseModel
DirectoryContent
¶
DirectoryRename
¶
file
¶
FileError
¶
Bases: Exception
File
¶
Bases: Base
repository_id
class-attribute
instance-attribute
¶
repository_id = mapped_column(
ForeignKey("repository.id", ondelete="CASCADE")
)
parent_id
class-attribute
instance-attribute
¶
parent_id = mapped_column(
ForeignKey("directory.id", ondelete="CASCADE"),
nullable=True,
)
created
class-attribute
instance-attribute
¶
created = mapped_column(
BigInteger, nullable=False, default=time
)
updated
class-attribute
instance-attribute
¶
updated = mapped_column(
BigInteger, nullable=False, default=time
)
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
new
async
¶
new(data, session, config)
PARAMETER | DESCRIPTION |
---|---|
data |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/file.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
|
remove
async
¶
remove(session, config)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/file.py
62 63 64 65 66 67 68 69 70 71 72 73 |
|
relative_path
async
¶
relative_path(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/file.py
75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
|
real_path
async
¶
real_path(session, config)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/file.py
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
|
by_path
async
staticmethod
¶
by_path(repository, path, session, config)
PARAMETER | DESCRIPTION |
---|---|
repository |
TYPE:
|
path |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/file.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
|
copy
async
¶
copy(
directory, session, config, force=False, shallow=False
)
PARAMETER | DESCRIPTION |
---|---|
directory |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
force |
TYPE:
|
shallow |
TYPE:
|
Source code in src/materia/models/file.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
|
move
async
¶
move(
directory, session, config, force=False, shallow=False
)
PARAMETER | DESCRIPTION |
---|---|
directory |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
force |
TYPE:
|
shallow |
TYPE:
|
Source code in src/materia/models/file.py
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
|
rename
async
¶
rename(name, session, config, force=False, shallow=False)
PARAMETER | DESCRIPTION |
---|---|
name |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
force |
TYPE:
|
shallow |
TYPE:
|
Source code in src/materia/models/file.py
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|
info
async
¶
info(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/file.py
219 220 221 222 223 224 |
|
FileLink
¶
Bases: Base
file_id
class-attribute
instance-attribute
¶
file_id = mapped_column(
ForeignKey("file.id", ondelete="CASCADE")
)
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
FileInfo
¶
Bases: BaseModel
FileRename
¶
FileCopyMove
¶
convert_bytes
¶
convert_bytes(size)
PARAMETER | DESCRIPTION |
---|---|
size |
TYPE:
|
Source code in src/materia/models/file.py
227 228 229 230 231 |
|
repository
¶
RepositoryError
¶
Bases: Exception
Repository
¶
Bases: Base
user_id
class-attribute
instance-attribute
¶
user_id = mapped_column(
ForeignKey("user.id", ondelete="CASCADE")
)
directories
class-attribute
instance-attribute
¶
directories = relationship(back_populates='repository')
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
new
async
¶
new(session, config)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/repository.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
|
real_path
async
¶
real_path(session, config)
Get absolute path of the directory.
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/repository.py
51 52 53 54 55 56 57 58 59 60 |
|
remove
async
¶
remove(session, config)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/repository.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
update
async
¶
update(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/repository.py
86 87 88 89 90 |
|
from_user
async
staticmethod
¶
from_user(user, session)
PARAMETER | DESCRIPTION |
---|---|
user |
TYPE:
|
session |
TYPE:
|
Source code in src/materia/models/repository.py
92 93 94 95 96 |
|
used_capacity
async
¶
used_capacity(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/repository.py
98 99 100 101 102 |
|
remaining_capacity
async
¶
remaining_capacity(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/repository.py
104 105 106 |
|
info
async
¶
info(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/repository.py
108 109 110 111 112 |
|
RepositoryInfo
¶
user
¶
UserError
¶
Bases: Exception
User
¶
Bases: Base
is_email_private
class-attribute
instance-attribute
¶
is_email_private = mapped_column(default=True)
must_change_password
class-attribute
instance-attribute
¶
must_change_password = mapped_column(default=False)
last_login
class-attribute
instance-attribute
¶
last_login = mapped_column(BigInteger, nullable=True)
to_dict
¶
to_dict()
Source code in src/materia/models/base.py
7 8 |
|
clone
¶
clone()
Clone model. Included: columns and values, foreign keys Ignored: primary keys, relationships
Source code in src/materia/models/base.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
new
async
¶
new(session, config)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/user.py
52 53 54 55 56 57 |
|
remove
async
¶
remove(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/user.py
59 60 61 62 63 64 65 66 67 |
|
update_last_login
¶
update_last_login()
Source code in src/materia/models/user.py
69 70 |
|
is_local
¶
is_local()
Source code in src/materia/models/user.py
72 73 |
|
is_oauth2
¶
is_oauth2()
Source code in src/materia/models/user.py
75 76 |
|
check_username
staticmethod
¶
check_username(name)
PARAMETER | DESCRIPTION |
---|---|
name |
TYPE:
|
Source code in src/materia/models/user.py
78 79 80 |
|
check_password
staticmethod
¶
check_password(password, config)
PARAMETER | DESCRIPTION |
---|---|
password |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/user.py
82 83 84 |
|
count
async
staticmethod
¶
count(session)
PARAMETER | DESCRIPTION |
---|---|
session |
TYPE:
|
Source code in src/materia/models/user.py
86 87 88 |
|
by_name
async
staticmethod
¶
by_name(name, session, with_lower=False)
PARAMETER | DESCRIPTION |
---|---|
name |
TYPE:
|
session |
TYPE:
|
with_lower |
TYPE:
|
Source code in src/materia/models/user.py
90 91 92 93 94 95 96 97 98 |
|
by_email
async
staticmethod
¶
by_email(email, session)
PARAMETER | DESCRIPTION |
---|---|
email |
TYPE:
|
session |
TYPE:
|
Source code in src/materia/models/user.py
100 101 102 103 104 |
|
by_id
async
staticmethod
¶
by_id(id, session)
PARAMETER | DESCRIPTION |
---|---|
id |
TYPE:
|
session |
TYPE:
|
Source code in src/materia/models/user.py
106 107 108 |
|
edit_name
async
¶
edit_name(name, session)
PARAMETER | DESCRIPTION |
---|---|
name |
TYPE:
|
session |
TYPE:
|
Source code in src/materia/models/user.py
110 111 112 113 114 115 116 117 118 119 |
|
edit_password
async
¶
edit_password(password, session, config)
PARAMETER | DESCRIPTION |
---|---|
password |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/user.py
121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
|
edit_email
async
¶
edit_email()
Source code in src/materia/models/user.py
136 137 |
|
info
¶
info()
Source code in src/materia/models/user.py
139 140 141 142 |
|
edit_avatar
async
¶
edit_avatar(avatar, session, config)
PARAMETER | DESCRIPTION |
---|---|
avatar |
TYPE:
|
session |
TYPE:
|
config |
TYPE:
|
Source code in src/materia/models/user.py
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
|
UserCredentials
¶
UserInfo
¶
Bases: BaseModel