Skip to content

Use flask blueprints #81

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.

Sign up for GitHub

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

Merged
Teester merged 1 commit into from
Oct 21, 2025
Merged

Use flask blueprints #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 44 additions & 0 deletions entityshape/api_v1_blueprint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
from flask import Blueprint, request, json, Response

from entityshape.shape import Shape
from entityshape.compareshape import CompareShape

api_v1 = Blueprint('api_v1', __name__,)

@api_v1.route('/')
def v1():
"""
Compares an entityschema with a wikidata item
:return: a response to the query
"""
schema: str = request.args.get("entityschema", type=str)
entity: str = request.args.get("entity", type=str)
if "Lexeme" in entity:
entity = entity[7:]
language: str = request.args.get("language", type=str)
try:
valid: dict = {}
entity_shape: Shape = Shape(schema, language)
comparison: CompareShape = CompareShape(entity_shape.get_schema_shape(), entity, language)
payload: dict = {'schema': schema,
'name': entity_shape.get_name(),
'validity': valid,
'general': comparison.get_general(),
'properties': comparison.get_properties(),
'statements': comparison.get_statements(),
'error': ""}
status: int = 200
except (AttributeError, TypeError, KeyError, IndexError) as exception:
payload: dict = {'schema': "",
'name': "",
'validity': "",
'general': "",
'properties': "",
'statements': "",
'error': "An error has occurred while translating this schema"}
status = 500
print(f"Schema: {schema} - {type(exception).__name__}: {exception}")
response: Response = Response(response=json.dumps(payload),
status=status,
mimetype="application/json")
return response
55 changes: 55 additions & 0 deletions entityshape/api_v2_blueprint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
from flask import Blueprint, request, json, Response

from entityshape.getjsonld import JSONLDShape
from entityshape.comparejsonld import CompareJSONLD


api_v2 = Blueprint('api_v2', __name__,)

@api_v2.route('/')
def v2():
"""
Compares an entityschema with a wikidata item
:return: a response to the query
"""
schema: str = request.args.get("entityschema", type=str)
schema_list: list = schema.split(', ')
entity: str = request.args.get("entity", type=str)
if "Lexeme" in entity:
entity = entity[7:]
language: str = request.args.get("language", type=str)
try:
valid: dict = {}
names: list = []
general: list = []
properties: list = []
statements: list = []
for schema in schema_list:
shape: JSONLDShape = JSONLDShape(schema, language)
comparison: CompareJSONLD = CompareJSONLD(shape.get_json_ld(), entity, language)
names.append(shape.get_name())
general.append(comparison.get_general())
properties.append(comparison.get_properties())
statements.append(comparison.get_statements())
payload: dict = {'schema': schema_list,
'name': names,
'validity': valid,
'general': general,
'properties': properties,
'statements': statements,
'error': ""}
status: int = 200
except (AttributeError, TypeError, KeyError, IndexError) as exception:
payload: dict = {'schema': "",
'name': "",
'validity': "",
'general': "",
'properties': "",
'statements': "",
'error': "An error has occurred while translating this schema"}
status = 500
print(f"Schema: {schema} - {type(exception).__name__}: {exception}")
response: Response = Response(response=json.dumps(payload),
status=status,
mimetype="application/json")
return response
122 changes: 5 additions & 117 deletions entityshape/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,129 +1,17 @@
"""
A Flask app to compare entityschema with wikidata items without using SPARQL
"""
from json import JSONDecodeError

import requests

from flask import Flask, request, json
from flask import Flask
from flask_cors import CORS
from requests import Response

from entityshape.comparejsonld import CompareJSONLD
from entityshape.compareshape import CompareShape
from entityshape.shape import Shape
from entityshape.getjsonld import JSONLDShape
from entityshape.api_v1_blueprint import api_v1
from entityshape.api_v2_blueprint import api_v2

app = Flask(__name__)
CORS(app)


@app.route("/api")
def v1():
"""
Compares an entityschema with a wikidata item
:return: a response to the query
"""
schema: str = request.args.get("entityschema", type=str)
entity: str = request.args.get("entity", type=str)
if "Lexeme" in entity:
entity = entity[7:]
language: str = request.args.get("language", type=str)
try:
# valid: dict = check_against_pyshexy(schema, entity)
valid: dict = {}
entity_shape: Shape = Shape(schema, language)
comparison: CompareShape = CompareShape(entity_shape.get_schema_shape(), entity, language)
payload: dict = {'schema': schema,
'name': entity_shape.get_name(),
'validity': valid,
'general': comparison.get_general(),
'properties': comparison.get_properties(),
'statements': comparison.get_statements(),
'error': ""}
status: int = 200
except (AttributeError, TypeError, KeyError, IndexError) as exception:
payload: dict = {'schema': "",
'name': "",
'validity': "",
'general': "",
'properties': "",
'statements': "",
'error': "An error has occurred while translating this schema"}
status = 500
print(f"Schema: {schema} - {type(exception).__name__}: {exception}")
response: Response = app.response_class(response=json.dumps(payload),
status=status,
mimetype="application/json")
return response


@app.route("/api/v2")
def v2():
"""
Compares an entityschema with a wikidata item
:return: a response to the query
"""
schema: str = request.args.get("entityschema", type=str)
schema_list: list = schema.split(', ')
entity: str = request.args.get("entity", type=str)
if "Lexeme" in entity:
entity = entity[7:]
language: str = request.args.get("language", type=str)
try:
# valid: dict = check_against_pyshexy(schema, entity)
valid: dict = {}
names: list = []
general: list = []
properties: list = []
statements: list = []
for schema in schema_list:
shape: JSONLDShape = JSONLDShape(schema, language)
comparison: CompareJSONLD = CompareJSONLD(shape.get_json_ld(), entity, language)
names.append(shape.get_name())
general.append(comparison.get_general())
properties.append(comparison.get_properties())
statements.append(comparison.get_statements())
payload: dict = {'schema': schema_list,
'name': names,
'validity': valid,
'general': general,
'properties': properties,
'statements': statements,
'error': ""}
status: int = 200
except (AttributeError, TypeError, KeyError, IndexError) as exception:
payload: dict = {'schema': "",
'name': "",
'validity': "",
'general': "",
'properties': "",
'statements': "",
'error': "An error has occurred while translating this schema"}
status = 500
print(f"Schema: {schema} - {type(exception).__name__}: {exception}")
response: Response = app.response_class(response=json.dumps(payload),
status=status,
mimetype="application/json")
return response


def check_against_pyshexy(entityschema: str, entity: str):
"""
Checks the entityschema and item against the pyshexy api
:param entityschema: the entityschema E number to be checked
:param entity: The entity Q number to be checked
:return: the response from pyshexy
"""
json_text: dict
url: str = f"https://tools.wmflabs.org/pyshexy/api?entityschema={entityschema}&entity={entity}"
try:
response: Response = requests.get(url)
json_text = response.json()
except JSONDecodeError as exception:
print(f"{type(exception).__name__}: {exception}")
json_text = {}
return json_text
app.register_blueprint(api_v1, url_prefix="/api")
app.register_blueprint(api_v2, url_prefix="/api/v2")


if __name__ == '__main__':
Expand Down