summaryrefslogtreecommitdiff
path: root/server/szurubooru
diff options
context:
space:
mode:
authorShyam Sunder <sgsunder1@gmail.com>2021-11-29 18:39:34 -0500
committerShyam Sunder <sgsunder1@gmail.com>2021-11-29 18:39:34 -0500
commit9b3123a8150faee660b4311d9d8c2c85a83b32b5 (patch)
treec35e76ce48472b6083d72bd510fff1b95d366d29 /server/szurubooru
parentf3aa0eb801afc9b0090769c08adcdd3e13caeaf0 (diff)
server: fix python docstring formatting
Diffstat (limited to 'server/szurubooru')
-rw-r--r--server/szurubooru/facade.py2
-rw-r--r--server/szurubooru/func/auth.py8
-rw-r--r--server/szurubooru/func/net.py2
-rw-r--r--server/szurubooru/func/util.py6
-rw-r--r--server/szurubooru/middleware/authenticator.py6
-rw-r--r--server/szurubooru/rest/app.py2
6 files changed, 13 insertions, 13 deletions
diff --git a/server/szurubooru/facade.py b/server/szurubooru/facade.py
index a7e4844..4c8084f 100644
--- a/server/szurubooru/facade.py
+++ b/server/szurubooru/facade.py
@@ -135,7 +135,7 @@ _live_migrations = (
def create_app() -> Callable[[Any, Any], Any]:
- """ Create a WSGI compatible App object. """
+ """Create a WSGI compatible App object."""
validate_config()
coloredlogs.install(fmt="[%(asctime)-15s] %(name)s %(message)s")
if config.config["debug"]:
diff --git a/server/szurubooru/func/auth.py b/server/szurubooru/func/auth.py
index d013775..17d25f7 100644
--- a/server/szurubooru/func/auth.py
+++ b/server/szurubooru/func/auth.py
@@ -25,7 +25,7 @@ RANK_MAP = OrderedDict(
def get_password_hash(salt: str, password: str) -> Tuple[str, int]:
- """ Retrieve argon2id password hash. """
+ """Retrieve argon2id password hash."""
return (
pwhash.argon2id.str(
(config.config["secret"] + salt + password).encode("utf8")
@@ -37,7 +37,7 @@ def get_password_hash(salt: str, password: str) -> Tuple[str, int]:
def get_sha256_legacy_password_hash(
salt: str, password: str
) -> Tuple[str, int]:
- """ Retrieve old-style sha256 password hash. """
+ """Retrieve old-style sha256 password hash."""
digest = hashlib.sha256()
digest.update(config.config["secret"].encode("utf8"))
digest.update(salt.encode("utf8"))
@@ -46,7 +46,7 @@ def get_sha256_legacy_password_hash(
def get_sha1_legacy_password_hash(salt: str, password: str) -> Tuple[str, int]:
- """ Retrieve old-style sha1 password hash. """
+ """Retrieve old-style sha1 password hash."""
digest = hashlib.sha1()
digest.update(b"1A2/$_4xVa")
digest.update(salt.encode("utf8"))
@@ -125,7 +125,7 @@ def verify_privilege(user: model.User, privilege_name: str) -> None:
def generate_authentication_token(user: model.User) -> str:
- """ Generate nonguessable challenge (e.g. links in password reminder). """
+ """Generate nonguessable challenge (e.g. links in password reminder)."""
assert user
digest = hashlib.md5()
digest.update(config.config["secret"].encode("utf8"))
diff --git a/server/szurubooru/func/net.py b/server/szurubooru/func/net.py
index 3f085a0..c53a62e 100644
--- a/server/szurubooru/func/net.py
+++ b/server/szurubooru/func/net.py
@@ -39,7 +39,7 @@ def download(url: str, use_video_downloader: bool = False) -> bytes:
length_tally = 0
try:
with urllib.request.urlopen(request) as handle:
- while (chunk := handle.read(_dl_chunk_size)) :
+ while chunk := handle.read(_dl_chunk_size):
length_tally += len(chunk)
if length_tally > config.config["max_dl_filesize"]:
raise DownloadTooLargeError(
diff --git a/server/szurubooru/func/util.py b/server/szurubooru/func/util.py
index f839136..453e121 100644
--- a/server/szurubooru/func/util.py
+++ b/server/szurubooru/func/util.py
@@ -83,12 +83,12 @@ def flip(source: Dict[Any, Any]) -> Dict[Any, Any]:
def is_valid_email(email: Optional[str]) -> bool:
- """ Return whether given email address is valid or empty. """
+ """Return whether given email address is valid or empty."""
return not email or re.match(r"^[^@]*@[^@]*\.[^@]*$", email) is not None
class dotdict(dict):
- """ dot.notation access to dictionary attributes. """
+ """dot.notation access to dictionary attributes."""
def __getattr__(self, attr: str) -> Any:
return self.get(attr)
@@ -98,7 +98,7 @@ class dotdict(dict):
def parse_time_range(value: str) -> Tuple[datetime, datetime]:
- """ Return tuple containing min/max time for given text representation. """
+ """Return tuple containing min/max time for given text representation."""
one_day = timedelta(days=1)
one_second = timedelta(seconds=1)
almost_one_day = one_day - one_second
diff --git a/server/szurubooru/middleware/authenticator.py b/server/szurubooru/middleware/authenticator.py
index e73b235..436543b 100644
--- a/server/szurubooru/middleware/authenticator.py
+++ b/server/szurubooru/middleware/authenticator.py
@@ -7,7 +7,7 @@ from szurubooru.rest.errors import HttpBadRequest
def _authenticate_basic_auth(username: str, password: str) -> model.User:
- """ Try to authenticate user. Throw AuthError for invalid users. """
+ """Try to authenticate user. Throw AuthError for invalid users."""
user = users.get_user_by_name(username)
if not auth.is_valid_password(user, password):
raise errors.AuthError("Invalid password.")
@@ -17,7 +17,7 @@ def _authenticate_basic_auth(username: str, password: str) -> model.User:
def _authenticate_token(
username: str, token: str
) -> Tuple[model.User, model.UserToken]:
- """ Try to authenticate user. Throw AuthError for invalid users. """
+ """Try to authenticate user. Throw AuthError for invalid users."""
user = users.get_user_by_name(username)
user_token = user_tokens.get_by_user_and_token(user, token)
if not auth.is_valid_token(user_token):
@@ -72,7 +72,7 @@ def _get_user(ctx: rest.Context, bump_login: bool) -> Optional[model.User]:
def process_request(ctx: rest.Context) -> None:
- """ Bind the user to request. Update last login time if needed. """
+ """Bind the user to request. Update last login time if needed."""
bump_login = ctx.get_param_as_bool("bump-login", default=False)
auth_user = _get_user(ctx, bump_login)
if auth_user:
diff --git a/server/szurubooru/rest/app.py b/server/szurubooru/rest/app.py
index a6f10fb..c098bd0 100644
--- a/server/szurubooru/rest/app.py
+++ b/server/szurubooru/rest/app.py
@@ -11,7 +11,7 @@ from szurubooru.rest import context, errors, middleware, routes
def _json_serializer(obj: Any) -> str:
- """ JSON serializer for objects not serializable by default JSON code """
+ """JSON serializer for objects not serializable by default JSON code"""
if isinstance(obj, datetime):
serial = obj.isoformat("T") + "Z"
return serial