Merge pull request #29 from petrobras/develop

Separate executable resolution from build skipping and centralize lookup

Author: afraniomelo

.github/workflows/build-test-release.yml

@@ -21,6 +21,7 @@ concurrency:
 
 env:
   MARLIM3_SKIP_BUILD: "1"
+  MARLIM3_SKIP_EXECUTABLE_RESOLUTION: "1"
   ARTIFACT_RETENTION_DAYS: "7"
 
 jobs:
@@ -586,6 +587,8 @@ jobs:
           - windows-2022
           - macos-14
     runs-on: ${{ matrix.os }}
+    env:
+      MARLIM3_SKIP_EXECUTABLE_RESOLUTION: "0"
 
     steps:
       - name: Set up Python

README.md

@@ -60,6 +60,8 @@ See [Compilation](#compilation) below. After building, copy `build/Marlim3` to `
 MARLIM3_SKIP_BUILD=1 uv sync --locked
 ```
 
+`MARLIM3_SKIP_BUILD=1` skips local CMake compilation. Set `MARLIM3_SKIP_EXECUTABLE_RESOLUTION=1` only when an import must not resolve or download the executable.
+
 ## Usage
 
 ### Option 1: Python Package
@@ -177,6 +179,8 @@ Then activate the package locally (skipping recompilation):
 MARLIM3_SKIP_BUILD=1 uv sync --locked
 ```
 
+`MARLIM3_SKIP_BUILD=1` skips local CMake compilation; installed packages can still download the release executable on import.
+
 ### Run tests
 
 ```bash

marlim3/__init__.py

@@ -3,7 +3,7 @@
 """
 
 # Import version from root _version.py
-import sys
+from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
 
 # Try to import from root _version.py (for development)
@@ -12,10 +12,8 @@
     if (_root_dir / '_version.py').exists():
         exec(open(_root_dir / '_version.py').read())
     else:
-        # Fallback for installed package
-        __version__ = '3.3.0'
-except:
-    # Fallback
+        __version__ = version("marlim3")
+except PackageNotFoundError:
     __version__ = '3.3.0'
 
 # Ensure executable is downloaded on first import
@@ -27,4 +25,4 @@
 from ._rede._rede import Rede
 from ._cenarios._cenarios import Cenarios
 
-__all__ = ['Tramo','Rede','Cenarios', '__version__']
+__all__ = ['Tramo','Rede','Cenarios', '__version__']

marlim3/_download.py

@@ -11,6 +11,11 @@
 import urllib.request
 from pathlib import Path
 
+
+def _env_flag(name):
+    return os.environ.get(name, "").strip().lower() not in {"", "0", "false", "no", "off"}
+
+
 def get_platform_asset_info():
     """Determine which asset to download based on the platform.
     
@@ -155,6 +160,9 @@ def _try_build_from_source():
     import subprocess
     import shutil
 
+    if _env_flag('MARLIM3_SKIP_BUILD'):
+        return False
+
     package_dir = Path(__file__).parent
     root_dir = package_dir.parent
 
@@ -207,8 +215,7 @@ def ensure_executable():
     
     This is called automatically on package import.
     """
-    # Skip if user wants to skip
-    if os.environ.get('MARLIM3_SKIP_BUILD'):
+    if _env_flag('MARLIM3_SKIP_EXECUTABLE_RESOLUTION'):
         return
 
     # Check if executable exists and works

marlim3/_rede/_rede.py

@@ -1,8 +1,9 @@
-import importlib.resources as pkg_resources
 import os
 import numpy as np
 import json 
 import shutil
+from contextlib import nullcontext
+from .._download import get_executable_path
 from .._plots._plots_perfis import _plotar_perfis, _plotar_perfis_animados
 from .._plots._plots_redes import _plotar_rede
 from .._tramo._tramo import Tramo
@@ -130,17 +131,10 @@ def simular(self, label='marlim3_rede',
                 tracker=None,
                 sanitized=False):
 
-        # Verificar o sistema operacional
-        if platform.system() == 'Windows':
-            executavel_name = 'Marlim3.exe'
-        else:
-            executavel_name = 'Marlim3'
-        
         if label != 'marlim3_rede':
             self.label = label
 
-        with pkg_resources.as_file(
-                pkg_resources.files('marlim3').joinpath(executavel_name)) as executavel:
+        with nullcontext(get_executable_path()) as executavel:
 
             filename = label+'.json'
 

marlim3/_tramo/_tramo.py

@@ -1,9 +1,10 @@
-import importlib.resources as pkg_resources
 import pandas as pd
 import json
 import os
 import shutil
 import requests
+from contextlib import nullcontext
+from .._download import get_executable_path
 from .._conversores._conversor_marlim3_tplppl import convert_to_ppl_tpl
 import matplotlib.cm as cm
 import matplotlib.pyplot as plt
@@ -282,17 +283,10 @@ def simular(self, kind='PRODUTOR',
                 tracker=None,
                 sanitized=False):
 
-        # Verificar o sistema operacional
-        if platform.system() == 'Windows':
-            executavel_name = 'Marlim3.exe'
-        else:
-            executavel_name = 'Marlim3'
-
         if label != 'marlim3_model':
             self.label = label
 
-        with pkg_resources.as_file(
-                pkg_resources.files('marlim3').joinpath(executavel_name)) as executavel:
+        with nullcontext(get_executable_path()) as executavel:
 
             filename = label+'.json'
 

tests/test_configure_simulation.py

@@ -9,37 +9,27 @@
 """
 
 import copy
-import importlib.resources as pkg_resources
 import os
-import platform
 
 import numpy as np
 import pandas as pd
 import pytest
 
 import marlim3
+from marlim3._download import executable_exists
 
 
 # ============================================================================
 # Verificação do executável
 # ============================================================================
 
 def _executavel_disponivel():
-    exe_name = "marlim3.exe" if platform.system() == "Windows" else "marlim3"
-    for name in [exe_name, "Marlim3.exe" if platform.system() == "Windows" else "Marlim3"]:
-        try:
-            ref = pkg_resources.files("marlim3").joinpath(name)
-            with pkg_resources.as_file(ref) as p:
-                if p.exists():
-                    return True
-        except (FileNotFoundError, AttributeError, TypeError):
-            continue
-    return False
+    return executable_exists()
 
 
 skip_sem_executavel = pytest.mark.skipif(
     not _executavel_disponivel(),
-    reason="Executável Marlim3 não encontrado no pacote",
+    reason="Executável Marlim3 não encontrado",
 )
 
 
@@ -121,4 +111,4 @@ def test_simulacao_vertical_roda(self, caso_base_vertical, tmp_path):
         assert "perfilProducao" in caso_base_vertical.resultados
         df = caso_base_vertical.resultados["perfilProducao"]
         assert isinstance(df, pd.DataFrame)
-        assert not df.empty
+        assert not df.empty

tests/test_demos_steady_state.py

@@ -8,36 +8,26 @@
     pytest tests/test_demos.py -v -m simulacao
 """
 
-import importlib.resources as pkg_resources
 import os
-import platform
 import shutil
 
 import pandas as pd
 import pytest
 
 import marlim3
+from marlim3._download import executable_exists
 
 # ============================================================================
 # Verificação do executável
 # ============================================================================
 
 def _executavel_disponivel():
-    exe_name = "marlim3.exe" if platform.system() == "Windows" else "marlim3"
-    for name in [exe_name, "Marlim3.exe" if platform.system() == "Windows" else "Marlim3"]:
-        try:
-            ref = pkg_resources.files("marlim3").joinpath(name)
-            with pkg_resources.as_file(ref) as p:
-                if p.exists():
-                    return True
-        except (FileNotFoundError, AttributeError, TypeError):
-            continue
-    return False
+    return executable_exists()
 
 
 skip_sem_executavel = pytest.mark.skipif(
     not _executavel_disponivel(),
-    reason="Executável Marlim3 não encontrado no pacote",
+    reason="Executável Marlim3 não encontrado",
 )
 
 # ============================================================================

tests/test_regression.py

@@ -9,37 +9,27 @@
     pytest tests/test_regression.py -v -m regressao
 """
 
-import importlib.resources as pkg_resources
 import os
-import platform
 import shutil
 
 import numpy as np
 import pandas as pd
 import pytest
 
 import marlim3
+from marlim3._download import executable_exists
 
 # ============================================================================
 # Verificação do executável
 # ============================================================================
 
 def _executavel_disponivel():
-    exe_name = "marlim3.exe" if platform.system() == "Windows" else "marlim3"
-    for name in [exe_name, "Marlim3.exe" if platform.system() == "Windows" else "Marlim3"]:
-        try:
-            ref = pkg_resources.files("marlim3").joinpath(name)
-            with pkg_resources.as_file(ref) as p:
-                if p.exists():
-                    return True
-        except (FileNotFoundError, AttributeError, TypeError):
-            continue
-    return False
+    return executable_exists()
 
 
 skip_sem_executavel = pytest.mark.skipif(
     not _executavel_disponivel(),
-    reason="Executável Marlim3 não encontrado no pacote",
+    reason="Executável Marlim3 não encontrado",
 )
 
 # ============================================================================