Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Silence various deprecation warnings #315

Merged
merged 4 commits into from
Sep 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ RUN apt-get update && apt-get install -y \
poppler-utils ffmpeg libavcodec-extra \
unzip \
libpq-dev postgresql-client postgresql-client-common python3-psycopg2 \
python3-opencv \
&& rm -rf /var/lib/apt/lists/*

# set locale
Expand Down Expand Up @@ -39,6 +38,10 @@ RUN wget https://github.com/gramps-project/addons/archive/refs/heads/master.zip
&& unzip -p master.zip addons-master/gramps$GRAMPS_VERSION/download/PostgreSQL.addon.tgz | \
tar -xvz -C /root/.gramps/gramps$GRAMPS_VERSION/plugins && rm master.zip

# install OpenCV
RUN python3 -m pip install --no-cache-dir --extra-index-url https://www.piwheels.org/simple \
opencv-python

# install gunicorn
RUN python3 -m pip install --no-cache-dir --extra-index-url https://www.piwheels.org/simple \
gunicorn
Expand Down
15 changes: 12 additions & 3 deletions gramps_webapi/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,10 @@ def register_endpt(resource: Type[Resource], url: str, name: str):
@api_blueprint.route("/media/<string:handle>/thumbnail/<int:size>")
@jwt_required_ifauth
@use_args(
{"square": fields.Boolean(missing=False), "jwt": fields.String(required=False)},
{
"square": fields.Boolean(load_default=False),
"jwt": fields.String(required=False),
},
location="query",
)
@thumbnail_cache.cached(make_cache_key=make_cache_key_thumbnails)
Expand All @@ -315,7 +318,10 @@ def get_thumbnail(args, handle, size):
)
@jwt_required_ifauth
@use_args(
{"square": fields.Boolean(missing=False), "jwt": fields.String(required=False)},
{
"square": fields.Boolean(load_default=False),
"jwt": fields.String(required=False),
},
location="query",
)
@thumbnail_cache.cached(make_cache_key=make_cache_key_thumbnails)
Expand All @@ -331,7 +337,10 @@ def get_cropped(args, handle: str, x1: int, y1: int, x2: int, y2: int):
)
@jwt_required_ifauth
@use_args(
{"square": fields.Boolean(missing=False), "jwt": fields.String(required=False)},
{
"square": fields.Boolean(load_default=False),
"jwt": fields.String(required=False),
},
location="query",
)
@thumbnail_cache.cached(make_cache_key=make_cache_key_thumbnails)
Expand Down
28 changes: 16 additions & 12 deletions gramps_webapi/api/resources/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ class GrampsObjectResource(GrampsObjectResourceHelper, Resource):

@use_args(
{
"backlinks": fields.Boolean(missing=False),
"backlinks": fields.Boolean(load_default=False),
"extend": fields.DelimitedList(
fields.Str(validate=validate.Length(min=1)),
validate=validate.ContainsOnly(
Expand Down Expand Up @@ -192,7 +192,9 @@ class GrampsObjectResource(GrampsObjectResourceHelper, Resource):
),
"format_options": fields.Str(validate=validate.Length(min=1)),
"keys": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
"locale": fields.Str(missing=None, validate=validate.Length(min=1, max=5)),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=1, max=5)
),
"profile": fields.DelimitedList(
fields.Str(validate=validate.Length(min=1)),
validate=validate.ContainsOnly(
Expand All @@ -211,8 +213,8 @@ class GrampsObjectResource(GrampsObjectResourceHelper, Resource):
"skipkeys": fields.DelimitedList(
fields.Str(validate=validate.Length(min=1))
),
"soundex": fields.Boolean(missing=False),
"strip": fields.Boolean(missing=False),
"soundex": fields.Boolean(load_default=False),
"strip": fields.Boolean(load_default=False),
},
location="query",
)
Expand Down Expand Up @@ -284,9 +286,9 @@ class GrampsObjectsResource(GrampsObjectResourceHelper, Resource):

@use_args(
{
"backlinks": fields.Boolean(missing=False),
"backlinks": fields.Boolean(load_default=False),
"dates": fields.Str(
missing=None,
load_default=None,
validate=validate.Regexp(
r"^([0-9]+|\*)/([1-9]|1[0-2]|\*)/([1-9]|1[0-9]|2[0-9]|3[0-1]|\*)$|"
r"^-[0-9]+/([1-9]|1[0-2])/([1-9]|1[0-9]|2[0-9]|3[0-1])$|"
Expand Down Expand Up @@ -326,9 +328,11 @@ class GrampsObjectsResource(GrampsObjectResourceHelper, Resource):
"format_options": fields.Str(validate=validate.Length(min=1)),
"gramps_id": fields.Str(validate=validate.Length(min=1)),
"keys": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
"locale": fields.Str(missing=None, validate=validate.Length(min=1, max=5)),
"page": fields.Integer(missing=0, validate=validate.Range(min=1)),
"pagesize": fields.Integer(missing=20, validate=validate.Range(min=1)),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=1, max=5)
),
"page": fields.Integer(load_default=0, validate=validate.Range(min=1)),
"pagesize": fields.Integer(load_default=20, validate=validate.Range(min=1)),
"profile": fields.DelimitedList(
fields.Str(validate=validate.Length(min=1)),
validate=validate.ContainsOnly(
Expand All @@ -349,9 +353,9 @@ class GrampsObjectsResource(GrampsObjectResourceHelper, Resource):
fields.Str(validate=validate.Length(min=1))
),
"sort": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
"soundex": fields.Boolean(missing=False),
"strip": fields.Boolean(missing=False),
"filemissing": fields.Boolean(missing=False),
"soundex": fields.Boolean(load_default=False),
"strip": fields.Boolean(load_default=False),
"filemissing": fields.Boolean(load_default=False),
},
location="query",
)
Expand Down
8 changes: 5 additions & 3 deletions gramps_webapi/api/resources/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,12 @@ def db_handle(self) -> DbReadBase:

@use_args(
{
"as_age": fields.Boolean(missing=True),
"locale": fields.Str(missing=None, validate=validate.Length(min=1, max=5)),
"as_age": fields.Boolean(load_default=True),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=1, max=5)
),
"precision": fields.Integer(
missing=2, validate=validate.Range(min=1, max=3)
load_default=2, validate=validate.Range(min=1, max=3)
),
},
location="query",
Expand Down
40 changes: 20 additions & 20 deletions gramps_webapi/api/resources/exporters.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,19 +183,19 @@ class ExporterFileResource(ProtectedResource, GrampsJSONEncoder):

@use_args(
{
"compress": fields.Boolean(missing=True),
"current_year": fields.Integer(missing=None),
"event": fields.Str(missing=None),
"gramps_id": fields.Str(missing=None),
"handle": fields.Str(missing=None),
"include_children": fields.Boolean(missing=True),
"include_individuals": fields.Boolean(missing=True),
"include_marriages": fields.Boolean(missing=True),
"include_media": fields.Boolean(missing=True),
"include_places": fields.Boolean(missing=True),
"include_witnesses": fields.Boolean(missing=True),
"compress": fields.Boolean(load_default=True),
"current_year": fields.Integer(load_default=None),
"event": fields.Str(load_default=None),
"gramps_id": fields.Str(load_default=None),
"handle": fields.Str(load_default=None),
"include_children": fields.Boolean(load_default=True),
"include_individuals": fields.Boolean(load_default=True),
"include_marriages": fields.Boolean(load_default=True),
"include_media": fields.Boolean(load_default=True),
"include_places": fields.Boolean(load_default=True),
"include_witnesses": fields.Boolean(load_default=True),
"living": fields.Str(
missing="IncludeAll",
load_default="IncludeAll",
validate=validate.OneOf(
[
"IncludeAll",
Expand All @@ -206,16 +206,16 @@ class ExporterFileResource(ProtectedResource, GrampsJSONEncoder):
]
),
),
"locale": fields.Str(missing=None),
"note": fields.Str(missing=None),
"person": fields.Str(missing=None),
"private": fields.Boolean(missing=False),
"reference": fields.Boolean(missing=False),
"locale": fields.Str(load_default=None),
"note": fields.Str(load_default=None),
"person": fields.Str(load_default=None),
"private": fields.Boolean(load_default=False),
"reference": fields.Boolean(load_default=False),
"sequence": fields.Str(
missing="privacy,living,person,event,note,reference"
load_default="privacy,living,person,event,note,reference"
),
"translate_headers": fields.Boolean(missing=True),
"years_after_death": fields.Integer(missing=0),
"translate_headers": fields.Boolean(load_default=True),
"years_after_death": fields.Integer(load_default=0),
"jwt": fields.String(required=False),
},
location="query",
Expand Down
16 changes: 9 additions & 7 deletions gramps_webapi/api/resources/facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ class FactsResource(ProtectedResource, GrampsJSONEncoder):

@use_args(
{
"gramps_id": fields.Str(missing=None, validate=validate.Length(min=1)),
"handle": fields.Str(missing=None, validate=validate.Length(min=1)),
"gramps_id": fields.Str(load_default=None, validate=validate.Length(min=1)),
"handle": fields.Str(load_default=None, validate=validate.Length(min=1)),
"living": fields.Str(
missing="IncludeAll",
load_default="IncludeAll",
validate=validate.OneOf(
[
"IncludeAll",
Expand All @@ -111,10 +111,12 @@ class FactsResource(ProtectedResource, GrampsJSONEncoder):
]
),
),
"locale": fields.Str(missing=None, validate=validate.Length(min=2, max=5)),
"person": fields.Str(missing=None, validate=validate.Length(min=1)),
"private": fields.Boolean(missing=False),
"rank": fields.Integer(missing=1, validate=validate.Range(min=1)),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=2, max=5)
),
"person": fields.Str(load_default=None, validate=validate.Length(min=1)),
"private": fields.Boolean(load_default=False),
"rank": fields.Integer(load_default=1, validate=validate.Range(min=1)),
},
location="query",
)
Expand Down
4 changes: 2 additions & 2 deletions gramps_webapi/api/resources/file.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class MediaFileResource(ProtectedResource):

@use_args(
{
"download": fields.Boolean(missing=False),
"download": fields.Boolean(load_default=False),
"jwt": fields.String(required=False),
},
location="query",
Expand All @@ -67,7 +67,7 @@ def get(self, args: Dict, handle) -> Response:

@use_args(
{
"uploadmissing": fields.Boolean(missing=False),
"uploadmissing": fields.Boolean(load_default=False),
},
location="query",
)
Expand Down
14 changes: 9 additions & 5 deletions gramps_webapi/api/resources/filters.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,18 +161,18 @@ class RuleSchema(Schema):

name = fields.Str(required=True, validate=validate.Length(min=1))
values = fields.List(fields.Raw, required=False)
regex = fields.Boolean(required=False, missing=False)
regex = fields.Boolean(required=False, load_default=False)


class FilterSchema(Schema):
"""Structure for a filter."""

function = fields.Str(
required=False,
missing="and",
load_default="and",
validate=validate.OneOf(["and", "or", "xor", "one"]),
)
invert = fields.Boolean(required=False, missing=False)
invert = fields.Boolean(required=False, load_default=False)
rules = fields.List(
fields.Nested(RuleSchema), required=True, validate=validate.Length(min=1)
)
Expand All @@ -192,7 +192,8 @@ class FiltersResources(ProtectedResource, GrampsJSONEncoder):
"""Filters resources."""

@use_args(
{}, location="query",
{},
location="query",
)
def get(self, args: Dict[str, str]) -> Response:
"""Get available custom filters and rules."""
Expand Down Expand Up @@ -286,7 +287,10 @@ def get(self, namespace: str, name: str) -> Response:
return self.response(200, filter_list[0])

@use_args(
{"force": fields.Str(validate=validate.Length(equal=0)),}, location="query",
{
"force": fields.Str(validate=validate.Length(equal=0)),
},
location="query",
)
def delete(self, args: Dict, namespace: str, name: str) -> Response:
"""Delete a custom filter."""
Expand Down
16 changes: 9 additions & 7 deletions gramps_webapi/api/resources/living.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ class LivingResource(ProtectedResource, GrampsJSONEncoder):
@use_args(
{
"average_generation_gap": fields.Integer(
missing=None, validate=validate.Range(min=1)
load_default=None, validate=validate.Range(min=1)
),
"max_age_probably_alive": fields.Integer(
missing=None, validate=validate.Range(min=1)
load_default=None, validate=validate.Range(min=1)
),
"max_sibling_age_difference": fields.Integer(
missing=None, validate=validate.Range(min=1)
load_default=None, validate=validate.Range(min=1)
),
},
location="query",
Expand Down Expand Up @@ -72,14 +72,16 @@ class LivingDatesResource(ProtectedResource, GrampsJSONEncoder):
@use_args(
{
"average_generation_gap": fields.Integer(
missing=None, validate=validate.Range(min=1)
load_default=None, validate=validate.Range(min=1)
),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=1, max=5)
),
"locale": fields.Str(missing=None, validate=validate.Length(min=1, max=5)),
"max_age_probably_alive": fields.Integer(
missing=None, validate=validate.Range(min=1)
load_default=None, validate=validate.Range(min=1)
),
"max_sibling_age_difference": fields.Integer(
missing=None, validate=validate.Range(min=1)
load_default=None, validate=validate.Range(min=1)
),
},
location="query",
Expand Down
12 changes: 8 additions & 4 deletions gramps_webapi/api/resources/relations.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,10 @@ class RelationResource(ProtectedResource, GrampsJSONEncoder):

@use_args(
{
"depth": fields.Integer(missing=15, validate=validate.Range(min=2)),
"locale": fields.Str(missing=None, validate=validate.Length(min=1, max=5)),
"depth": fields.Integer(load_default=15, validate=validate.Range(min=2)),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=1, max=5)
),
},
location="query",
)
Expand Down Expand Up @@ -76,8 +78,10 @@ class RelationsResource(ProtectedResource, GrampsJSONEncoder):

@use_args(
{
"depth": fields.Integer(missing=15, validate=validate.Range(min=2)),
"locale": fields.Str(missing=None, validate=validate.Length(min=1, max=5)),
"depth": fields.Integer(load_default=15, validate=validate.Range(min=2)),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=1, max=5)
),
},
location="query",
)
Expand Down
10 changes: 6 additions & 4 deletions gramps_webapi/api/resources/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,18 +87,20 @@ def get_object_from_handle(

@use_args(
{
"locale": fields.Str(missing=None, validate=validate.Length(min=1, max=5)),
"locale": fields.Str(
load_default=None, validate=validate.Length(min=1, max=5)
),
"query": fields.Str(required=True, validate=validate.Length(min=1)),
"page": fields.Int(missing=1, validate=validate.Range(min=1)),
"pagesize": fields.Int(missing=20, validate=validate.Range(min=1)),
"page": fields.Int(load_default=1, validate=validate.Range(min=1)),
"pagesize": fields.Int(load_default=20, validate=validate.Range(min=1)),
"sort": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
"profile": fields.DelimitedList(
fields.Str(validate=validate.Length(min=1)),
validate=validate.ContainsOnly(
choices=["all", "self", "families", "events", "age", "span"]
),
),
"strip": fields.Boolean(missing=False),
"strip": fields.Boolean(load_default=False),
},
location="query",
)
Expand Down
Loading