add requirements.txt

add functions

Author: JulienChampagnol

.gitignore

@@ -1,3 +1,4 @@
 .pytest_cache
 dist
-venv
+venv
+__pycache__

requirements.txt

@@ -0,0 +1,35 @@
+#
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
+#
+#    pip-compile requirements.in
+#
+geode-common==26.3.0
+    # via geode-viewables
+geode-viewables==2.1.0
+    # via -r requirements.in
+opengeode-core==14.8.0
+    # via
+    #   -r requirements.in
+    #   geode-viewables
+    #   opengeode-geosciences
+    #   opengeode-geosciencesio
+    #   opengeode-inspector
+    #   opengeode-io
+opengeode-geosciences==7.2.0
+    # via
+    #   -r requirements.in
+    #   geode-viewables
+    #   opengeode-geosciencesio
+    #   opengeode-inspector
+opengeode-geosciencesio==4.5.0
+    # via
+    #   -r requirements.in
+    #   opengeode-inspector
+opengeode-inspector==3.1.0
+    # via -r requirements.in
+opengeode-io==6.2.0
+    # via
+    #   -r requirements.in
+    #   geode-viewables
+    #   opengeode-inspector

src/opengeodeweb_back/geode_functions.py

@@ -16,9 +16,99 @@
 from .geode_objects import objects_list
 
 
+def get_input(geode_object: str):
+    return objects_list()[geode_object]["input"]
+
+
+def get_output(geode_object: str):
+    return objects_list()[geode_object]["output"]
+
+
+def load(geode_object: str, file_absolute_path: str):
+    return objects_list()[geode_object]["load"](file_absolute_path)
+
+
+def save(geode_object: str, data, folder_absolute_path: str, filename: str):
+    return objects_list()[geode_object]["save"](
+        data, os.path.join(folder_absolute_path, filename)
+    )
+
+
+def get_builder(geode_object: str, data):
+    return objects_list()[geode_object]["builder"](data)
+
+
+def assign_crs(geode_object: str, data, crs_name: str, info):
+    builder = get_builder(geode_object, data)
+    objects_list()[geode_object]["crs"]["assign"](data, builder, crs_name, info)
+
+
+def convert_crs(geode_object: str, data, crs_name: str, info):
+    builder = get_builder(geode_object, data)
+    objects_list()[geode_object]["crs"]["convert"](data, builder, crs_name, info)
+
+
+def create_coordinate_system(
+    geode_object: str,
+    data,
+    name: str,
+    input_coordiante_system,
+    output_coordiante_system,
+):
+    builder = get_builder(geode_object, data)
+    objects_list()[geode_object]["crs"]["create"](
+        data, builder, name, input_coordiante_system, output_coordiante_system
+    )
+
+
+def is_model(geode_object: str):
+    return objects_list()[geode_object]["is_model"]
+
+
+def is_3D(geode_object: str):
+    return objects_list()[geode_object]["is_3D"]
+
+
+def is_viewable(geode_object: str):
+    return objects_list()[geode_object]["is_viewable"]
+
+
+def save_viewable(geode_object: str, data, folder_absolute_path: str, id: str):
+    return objects_list()[geode_object]["save_viewable"](
+        data, os.path.join(folder_absolute_path, id)
+    )
+
+
+def get_inspector(geode_object: str, data):
+    return objects_list()[geode_object]["inspector"](data)
+
+
+def get_geode_object_input_extensions(geode_object: str):
+    inputs_list = []
+    geode_object_inputs = get_input(geode_object)
+
+    for input in geode_object_inputs:
+        list_creators = input.list_creators()
+        inputs_list = inputs_list + list_creators
+    inputs_list = list(set(inputs_list))
+    inputs_list.sort()
+    return inputs_list
+
+
+def get_geode_object_output_extensions(geode_object: str):
+    output_list = []
+    geode_object_outputs = get_output(geode_object)
+
+    for output in geode_object_outputs:
+        list_creators = output.list_creators()
+        output_list = output_list + list_creators
+    output_list = list(set(output_list))
+    output_list.sort()
+    return output_list
+
+
 def list_input_extensions(
     keys: list = [],
-    geode_object: str = "",
 ):
     """
     Purpose:
@@ -30,9 +120,8 @@ def list_input_extensions(
         An ordered list of input file extensions
     """
     extensions_list = []
-    geode_object_dict = objects_list()
 
-    for geode_object in geode_object_dict.values():
+    for geode_object, value in objects_list().items():
         if keys:
             for key in keys:
                 if key in geode_object:
@@ -43,18 +132,15 @@ def list_input_extensions(
                 else:
                     continue
 
-        values = geode_object["input"]
+        geode_object_list_inputs = get_geode_object_input_extensions(geode_object)
+        extensions_list = extensions_list + geode_object_list_inputs
 
-        for value in values:
-            list_creators = value.list_creators()
-            for creator in list_creators:
-                if creator not in extensions_list:
-                    extensions_list.append(creator)
+    extensions_list = list(set(extensions_list))
     extensions_list.sort()
     return extensions_list
 
 
-def list_objects(extension: str, is_viewable: bool = True):
+def list_geode_objects(extension: str, keys: list = []):
     """
     Purpose:
         Function that returns a list of objects that can handle a file, given his extension
@@ -63,40 +149,16 @@ def list_objects(extension: str, is_viewable: bool = True):
     Returns:
         An ordered list of object's names
     """
-    return_list = []
-    geode_object_dict = objects_list()
+    geode_objects_list = []
 
-    for object_, values in geode_object_dict.items():
-        # if values["is_viewable"] == is_viewable:
-        list_values = values["input"]
-        for value in list_values:
-            if value.has_creator(extension):
-                if object_ not in return_list:
-                    return_list.append(object_)
-    return_list.sort()
-    return return_list
-
-
-def list_output_file_extensions(object: str):
-    """
-    Purpose:
-        Function that returns a list of output file extensions that can be handled by an object
-    Args:
-        object -- The name of the object
-    Returns:
-        An ordered list of file extensions
-    """
-    List = []
-    geode_object_dict = objects_list()
-
-    values = geode_object_dict[object]["output"]
-    for value in values:
-        list_creators = value.list_creators()
-        for creator in list_creators:
-            if creator not in List:
-                List.append(creator)
-    List.sort()
-    return List
+    for geode_object, value in objects_list().items():
+        geode_object_inputs = get_geode_object_input(geode_object)
+        for input in geode_object_inputs:
+            if input.has_creator(extension):
+                if geode_object not in geode_objects_list:
+                    geode_objects_list.append(geode_object)
+    geode_objects_list.sort()
+    return geode_objects_list
 
 
 def get_versions(list_packages: list):
@@ -168,64 +230,12 @@ def func_wrapper():
     return t
 
 
-def is_model(geode_object):
-    return objects_list()[geode_object]["is_model"]
-
-
-def is_3D(geode_object):
-    return objects_list()[geode_object]["is_3D"]
-
-
-def get_builder(geode_object, data):
-    return objects_list()[geode_object]["builder"](data)
-
-
-def get_inspector(geode_object, data):
-    return objects_list()[geode_object]["inspector"](data)
-
-
-def load(geode_object, file_absolute_path):
-    return objects_list()[geode_object]["load"](file_absolute_path)
-
-
-def save(geode_object, data, folder_absolute_path, filename):
-    objects_list()[geode_object]["save"](
-        data, os.path.join(folder_absolute_path, filename)
-    )
-
-
-def save_viewable(geode_object, data, folder_absolute_path, id):
-    objects_list()[geode_object]["save_viewable"](
-        data, os.path.join(folder_absolute_path, id)
-    )
-
-
-def assign_crs(geode_object, data, crs_name, info):
-    builder = get_builder(geode_object, data)
-    objects_list()[geode_object]["crs"]["assign"](data, builder, crs_name, info)
-
-
-def convert_crs(geode_object, data, crs_name, info):
-    builder = get_builder(geode_object, data)
-    objects_list()[geode_object]["crs"]["convert"](data, builder, crs_name, info)
-
-
-def create_crs(
-    geode_object, data, name, input_coordiante_system, output_coordiante_system
-):
-    builder = get_builder(geode_object, data)
-    objects_list()[geode_object]["crs"]["create"](
-        data, builder, name, input_coordiante_system, output_coordiante_system
-    )
-
-
 def get_extension_from_filename(filename):
     return os.path.splitext(filename)[1][1:]
 
 
 def get_form_variables(form, variables_array):
     variables_dict = {}
-
     for variable in variables_array:
         if form.get(variable) is None:
             flask.abort(400, f"No {variable} sent")
@@ -234,14 +244,14 @@ def get_form_variables(form, variables_array):
     return variables_dict
 
 
-def get_geographic_coordinate_systems(geode_object):
+def get_geographic_coordinate_systems(geode_object: str):
     if is_3D(geode_object):
         return og_gs.GeographicCoordinateSystem3D.geographic_coordinate_systems()
     else:
         return og_gs.GeographicCoordinateSystem2D.geographic_coordinate_systems()
 
 
-def get_geographic_coordinate_systems_info(geode_object, crs):
+def get_geographic_coordinate_systems_info(geode_object: str, crs):
     if is_3D(geode_object):
         return og_gs.GeographicCoordinateSystemInfo3D(
             crs["authority"], crs["code"], crs["name"]
@@ -252,7 +262,7 @@ def get_geographic_coordinate_systems_info(geode_object, crs):
         )
 
 
-def get_coordinate_system(geode_object, coordinate_system):
+def get_coordinate_system(geode_object: str, coordinate_system):
     return og.CoordinateSystem2D(
         [
             og.Vector2D(
@@ -276,18 +286,18 @@ def get_coordinate_system(geode_object, coordinate_system):
     )
 
 
-def assign_geographic_coordinate_system_info(geode_object, data, input_crs):
+def assign_geographic_coordinate_system_info(geode_object: str, data, input_crs):
     info = get_geographic_coordinate_systems_info(geode_object, input_crs)
     assign_crs(geode_object, data, input_crs["name"], info)
 
 
-def convert_geographic_coordinate_system_info(geode_object, data, output_crs):
+def convert_geographic_coordinate_system_info(geode_object: str, data, output_crs):
     info = get_geographic_coordinate_systems_info(geode_object, output_crs)
     convert_crs(geode_object, data, output_crs["name"], info)
 
 
 def create_coordinate_system(
-    geode_object, data, name, input_coordinate_points, output_coordinate_points
+    geode_object: str, data, name, input_coordinate_points, output_coordinate_points
 ):
     builder = get_builder(geode_object, data)
 

tests/test_geode_functions.py

@@ -1,4 +1,4 @@
-from .srcimport import geode_functions
+from .src import geode_functions
 
 
 def test_is_model():