fix: Add __all__ in __init__.py files (#501)

* Add changelog entry
* Update pre-commit config to warn about unused imports in __init__.py

Author: ValerianRey

.pre-commit-config.yaml

@@ -15,7 +15,6 @@ repos:
     -   id: flake8  # Check style and syntax. Does not modify code, issues have to be solved manually.
         args: [
             '--ignore=E501,E203,W503,E402',  # Ignore line length problems, space after colon problems, line break occurring before a binary operator problems, module level import not at top of file problems.
-            '--per-file-ignores=*/__init__.py:F401',  # Ignore module imported but unused problems in __init__.py files.
         ]
 
 -   repo: https://github.com/pycqa/isort

CHANGELOG.md

@@ -8,6 +8,10 @@ changes that do not affect the user.
 
 ## [Unreleased]
 
+### Added
+
+- Added `__all__` in the `__init__.py` of packages. This should prevent PyLance from triggering warnings when importing from `torchjd`.
+
 ## [0.8.0] - 2025-11-13
 
 ### Added

docs/source/docs/autogram/index.rst

@@ -1,9 +1,8 @@
 autogram
 ========
 
-
 .. automodule:: torchjd.autogram
-   :members:
+    :no-members:
 
 .. toctree::
     :hidden:

docs/source/docs/autojac/index.rst

@@ -2,8 +2,7 @@ autojac
 =======
 
 .. automodule:: torchjd.autojac
-   :members:
-
+   :no-members:
 
 .. toctree::
     :hidden:

src/torchjd/aggregation/__init__.py

@@ -80,12 +80,48 @@
 )
 from ._weighting_bases import GeneralizedWeighting, Weighting
 
+__all__ = [
+    "Aggregator",
+    "AlignedMTL",
+    "AlignedMTLWeighting",
+    "ConFIG",
+    "Constant",
+    "ConstantWeighting",
+    "DualProj",
+    "DualProjWeighting",
+    "Flattening",
+    "GeneralizedWeighting",
+    "GradDrop",
+    "IMTLG",
+    "IMTLGWeighting",
+    "Krum",
+    "KrumWeighting",
+    "Mean",
+    "MeanWeighting",
+    "MGDA",
+    "MGDAWeighting",
+    "PCGrad",
+    "PCGradWeighting",
+    "Random",
+    "RandomWeighting",
+    "Sum",
+    "SumWeighting",
+    "TrimmedMean",
+    "UPGrad",
+    "UPGradWeighting",
+    "Weighting",
+]
+
 try:
     from ._cagrad import CAGrad, CAGradWeighting
+
+    __all__ += ["CAGrad", "CAGradWeighting"]
 except _OptionalDepsNotInstalledError:  # The required dependencies are not installed
     pass
 
 try:
     from ._nash_mtl import NashMTL
+
+    __all__ += ["NashMTL"]
 except _OptionalDepsNotInstalledError:  # The required dependencies are not installed
     pass

src/torchjd/autogram/__init__.py

@@ -28,3 +28,5 @@
 """
 
 from ._engine import Engine
+
+__all__ = ["Engine"]

src/torchjd/autojac/__init__.py

@@ -7,3 +7,5 @@
 
 from ._backward import backward
 from ._mtl_backward import mtl_backward
+
+__all__ = ["backward", "mtl_backward"]

src/torchjd/autojac/_transform/__init__.py

@@ -8,3 +8,19 @@
 from ._ordered_set import OrderedSet
 from ._select import Select
 from ._stack import Stack
+
+__all__ = [
+    "Accumulate",
+    "Aggregate",
+    "Composition",
+    "Conjunction",
+    "Diagonalize",
+    "Grad",
+    "Init",
+    "Jac",
+    "OrderedSet",
+    "RequirementError",
+    "Select",
+    "Stack",
+    "Transform",
+]