Merge pull request #117 from shunichironomura/feature/add-__all__

Add __all__

capsula/__init__.py

@@ -1,3 +1,13 @@
+__all__ = [
+    "monitor",
+    "__version__",
+    "CapsulaConfigurationError",
+    "CapsulaError",
+    "get_capsule_dir",
+    "get_capsule_name",
+    "set_capsule_dir",
+    "set_capsule_name",
+]
 from ._monitor import monitor
 from ._version import __version__
 from .exceptions import CapsulaConfigurationError, CapsulaError

capsula/_monitor.py

@@ -1,3 +1,18 @@
+__all__ = [
+    "PreRunInfoBase",
+    "PreRunInfoCli",
+    "PreRunInfoFunc",
+    "OutputFileInfo",
+    "PostRunInfoBase",
+    "PostRunInfoCli",
+    "PostRunInfoFunc",
+    "ExceptionInfo",
+    "OutputFileInfo",
+    "MonitoringHandlerBase",
+    "MonitoringHandlerCli",
+    "MonitoringHandlerFunc",
+    "monitor",
+]
 import inspect
 import logging
 import subprocess

capsula/config.py

@@ -1,3 +1,10 @@
+__all__ = [
+    "GitConfig",
+    "CaptureConfig",
+    "MonitorItemConfig",
+    "MonitorConfig",
+    "CapsulaConfig",
+]
 import sys
 from datetime import datetime
 from pathlib import Path

capsula/context.py

@@ -1,3 +1,13 @@
+__all__ = [
+    "ContextItem",
+    "Architecture",
+    "PythonInfo",
+    "Platform",
+    "GitRemote",
+    "GitInfo",
+    "FileContext",
+    "Context",
+]
 import os
 import platform as pf
 import sys

capsula/exceptions.py

@@ -1,3 +1,6 @@
+__all__ = ["CapsulaError", "CapsulaConfigurationError"]
+
+
 class CapsulaError(Exception):
     pass
 

capsula/file.py

@@ -1,3 +1,4 @@
+__all__ = ["CaptureFileConfig"]
 from typing import Optional
 
 from pydantic import BaseModel, Field, model_validator

capsula/globalvars.py

@@ -1,3 +1,9 @@
+__all__ = [
+    "set_capsule_dir",
+    "get_capsule_dir",
+    "set_capsule_name",
+    "get_capsule_name",
+]
 import os
 from pathlib import Path
 from typing import Union
@@ -10,7 +16,6 @@ def set_capsule_dir(path: Union[Path, str]) -> None:
     os.environ["CAPSULA_CAPSULE_DIR"] = str(path)
 
 
-
 def get_capsule_dir() -> Path:
     """Get the capsule directory used by the CLI."""
     try:

capsula/hash.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "HashAlgorithm",
+    "compute_hash",
+]
 import hashlib
 import logging
 from enum import Enum