Get import supported extensions (#889)

Signed-off-by: Geoffroy Jamgotchian <geoffroy.jamgotchian@rte-france.com>
powsybl · Nov 19, 2024 · e1080db · e1080db
1 parent 9a73dba
commit e1080db
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 0 deletions.
diff --git a/cpp/powsybl-cpp/powsybl-cpp.cpp b/cpp/powsybl-cpp/powsybl-cpp.cpp
@@ -491,6 +491,12 @@ std::vector<std::string> getNetworkImportPostProcessors() {
     return postProcessors.get();
 }
 
+std::vector<std::string> getNetworkImportSupportedExtensions() {
+    auto supportedExtensionsArrayPtr = PowsyblCaller::get()->callJava<array*>(::getNetworkImportSupportedExtensions);
+    ToStringVector supportedExtensions(supportedExtensionsArrayPtr);
+    return supportedExtensions.get();
+}
+
 std::vector<std::string> getLoadFlowProviderNames() {
     auto formatsArrayPtr = PowsyblCaller::get()->callJava<array*>(::getLoadFlowProviderNames);
     ToStringVector formats(formatsArrayPtr);

diff --git a/cpp/powsybl-cpp/powsybl-cpp.h b/cpp/powsybl-cpp/powsybl-cpp.h
@@ -519,6 +519,8 @@ std::vector<std::string> getNetworkElementsIds(const JavaHandle& network, elemen
 
 std::vector<std::string> getNetworkImportFormats();
 
+std::vector<std::string> getNetworkImportSupportedExtensions();
+
 std::vector<std::string> getNetworkExportFormats();
 
 std::vector<std::string> getNetworkImportPostProcessors();

diff --git a/cpp/pypowsybl-cpp/bindings.cpp b/cpp/pypowsybl-cpp/bindings.cpp
@@ -371,6 +371,7 @@ PYBIND11_MODULE(_pypowsybl, m) {
           py::arg("not_connected_to_same_bus_at_both_sides"));
 
     m.def("get_network_import_formats", &pypowsybl::getNetworkImportFormats, "Get supported import formats");
+    m.def("get_network_import_supported_extensions", &pypowsybl::getNetworkImportSupportedExtensions, "Get supported import extensions");
     m.def("get_network_export_formats", &pypowsybl::getNetworkExportFormats, "Get supported export formats");
     m.def("get_network_import_post_processors", &pypowsybl::getNetworkImportPostProcessors, "Get supported import post processors");
 

diff --git a/java/src/main/java/com/powsybl/python/network/NetworkCFunctions.java b/java/src/main/java/com/powsybl/python/network/NetworkCFunctions.java
@@ -95,6 +95,11 @@ public static ArrayPointer<CCharPointerPointer> getNetworkImportFormats(IsolateT
         return doCatch(exceptionHandlerPtr, () -> createCharPtrArray(Importer.getFormats().stream().sorted().toList()));
     }
 
+    @CEntryPoint(name = "getNetworkImportSupportedExtensions")
+    public static ArrayPointer<CCharPointerPointer> getNetworkImportSupportedExtensions(IsolateThread thread, ExceptionHandlerPointer exceptionHandlerPtr) {
+        return doCatch(exceptionHandlerPtr, () -> createCharPtrArray(Importer.list().stream().flatMap(l -> l.getSupportedExtensions().stream()).distinct().sorted().toList()));
+    }
+
     @CEntryPoint(name = "getNetworkExportFormats")
     public static ArrayPointer<CCharPointerPointer> getNetworkExportFormats(IsolateThread thread, ExceptionHandlerPointer exceptionHandlerPtr) {
         return doCatch(exceptionHandlerPtr, () -> createCharPtrArray(Exporter.getFormats().stream().sorted().toList()));

diff --git a/pypowsybl/_pypowsybl.pyi b/pypowsybl/_pypowsybl.pyi
@@ -786,6 +786,7 @@ def get_network_area_diagram_displayed_voltage_levels(network: JavaHandle, volta
 def get_network_elements_ids(network: JavaHandle, element_type: ElementType, nominal_voltages: List[float], countries: List[str], main_connected_component: bool, main_synchronous_component: bool, not_connected_to_same_bus_at_both_sides: bool) -> List[str]: ...
 def get_network_export_formats() -> List[str]: ...
 def get_network_import_formats() -> List[str]: ...
+def get_network_import_supported_extensions() -> List[str]: ...
 def get_network_import_post_processors() -> List[str]: ...
 def get_loadflow_provider_names() -> List[str]: ...
 def get_security_analysis_provider_names() -> List[str]: ...

diff --git a/pypowsybl/network/__init__.py b/pypowsybl/network/__init__.py
@@ -43,6 +43,7 @@
     get_extensions_names,
     get_single_line_diagram_component_library_names,
     get_import_formats,
+    get_import_supported_extensions,
     get_export_formats,
     get_import_post_processors,
     get_import_parameters,

diff --git a/pypowsybl/network/impl/util.py b/pypowsybl/network/impl/util.py
@@ -31,6 +31,16 @@ def get_import_formats() -> List[str]:
     return _pp.get_network_import_formats()
 
 
+def get_import_supported_extensions() -> List[str]:
+    """
+    Get list of supported import extensions
+
+    Returns:
+         the list of supported import extensions
+    """
+    return _pp.get_network_import_supported_extensions()
+
+
 def get_export_formats() -> List[str]:
     """
     Get list of supported export formats

diff --git a/tests/test_network.py b/tests/test_network.py
@@ -157,6 +157,11 @@ def test_get_import_format():
     assert ['BIIDM', 'CGMES', 'IEEE-CDF', 'JIIDM', 'MATPOWER', 'POWER-FACTORY', 'PSS/E', 'UCTE', 'XIIDM'] == formats
 
 
+def test_get_import_supported_extensions():
+    extensions = pp.network.get_import_supported_extensions()
+    assert ['RAW', 'RAWX', 'UCT', 'biidm', 'bin', 'dgs', 'iidm', 'jiidm', 'json', 'mat', 'raw', 'rawx', 'txt', 'uct', 'xiidm', 'xml'] == extensions
+
+
 def test_get_import_parameters():
     parameters = pp.network.get_import_parameters('PSS/E')
     assert 1 == len(parameters)