Add __all__ to __init__.py files for explicit exports

BattlefieldDuck · BattlefieldDuck · commit 36887493c136 · 2025-12-18T04:46:39.000+08:00
Added __all__ lists to the __init__.py files across exceptions, protocols, rcon_protocols, and responses modules to explicitly define public API exports. This improves clarity and control over what is exposed when using 'from ... import *'.
diff --git a/opengsq/exceptions/__init__.py b/opengsq/exceptions/__init__.py
@@ -1,3 +1,9 @@
 from .authentication_exception import AuthenticationException
 from .invalid_packet_exception import InvalidPacketException
 from .server_not_found_exception import ServerNotFoundException
+
+__all__ = [
+    "AuthenticationException",
+    "InvalidPacketException",
+    "ServerNotFoundException",
+]
diff --git a/opengsq/protocols/__init__.py b/opengsq/protocols/__init__.py
@@ -47,3 +47,55 @@
 from opengsq.protocols.w40kdow import W40kDow
 from opengsq.protocols.warcraft3 import Warcraft3
 from opengsq.protocols.won import WON
+
+__all__ = [
+    "AoE1",
+    "AoE2",
+    "ASE",
+    "AVP2",
+    "Battlefield",
+    "Battlefield2",
+    "CoD1",
+    "CoD4",
+    "CoD5",
+    "DirectPlay",
+    "Doom3",
+    "ElDewrito",
+    "EOS",
+    "FiveM",
+    "Flatout2",
+    "GameSpy1",
+    "GameSpy2",
+    "GameSpy3",
+    "GameSpy4",
+    "Halo1",
+    "JediKnight",
+    "Kaillera",
+    "KillingFloor",
+    "Minecraft",
+    "Nadeo",
+    "Palworld",
+    "Quake1",
+    "Quake2",
+    "Quake3",
+    "RakNet",
+    "RenegadeX",
+    "Samp",
+    "Satisfactory",
+    "Scum",
+    "Source",
+    "SSC",
+    "SupCom",
+    "StrongholdCE",
+    "StrongholdCrusader",
+    "TeamSpeak3",
+    "TrackmaniaNations",
+    "Toxikk",
+    "UDK",
+    "Unreal2",
+    "UT3",
+    "Vcmp",
+    "W40kDow",
+    "Warcraft3",
+    "WON",
+]
diff --git a/opengsq/rcon_protocols/__init__.py b/opengsq/rcon_protocols/__init__.py
@@ -1 +1,3 @@
 from .source_rcon import SourceRcon
+
+__all__ = ["SourceRcon"]
diff --git a/opengsq/responses/ase/__init__.py b/opengsq/responses/ase/__init__.py
@@ -1,2 +1,4 @@
 from .player import Player
 from .status import Status
+
+__all__ = ["Player", "Status"]
diff --git a/opengsq/responses/battlefield/__init__.py b/opengsq/responses/battlefield/__init__.py
@@ -1,2 +1,4 @@
 from .info import Info
 from .version_info import VersionInfo
+
+__all__ = ["Info", "VersionInfo"]
diff --git a/opengsq/responses/cod1/__init__.py b/opengsq/responses/cod1/__init__.py
@@ -1,3 +1,5 @@
 from .info import Info
 from .status import Status
 from .cod1_status import Cod1Status
+
+__all__ = ["Info", "Status", "Cod1Status"]
diff --git a/opengsq/responses/cod4/__init__.py b/opengsq/responses/cod4/__init__.py
@@ -1,3 +1,5 @@
 from .info import Info
 from .status import Status
 from .cod4_status import Cod4Status
+
+__all__ = ["Info", "Status", "Cod4Status"]
diff --git a/opengsq/responses/cod5/__init__.py b/opengsq/responses/cod5/__init__.py
@@ -1,3 +1,5 @@
 from .info import Info
 from .status import Status
 from .cod5_status import Cod5Status
+
+__all__ = ["Info", "Status", "Cod5Status"]
diff --git a/opengsq/responses/doom3/__init__.py b/opengsq/responses/doom3/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/eos/__init__.py b/opengsq/responses/eos/__init__.py
@@ -1 +1,3 @@
 from .matchmaking import Matchmaking
+
+__all__ = ["Matchmaking"]
diff --git a/opengsq/responses/flatout2/__init__.py b/opengsq/responses/flatout2/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/gamespy1/__init__.py b/opengsq/responses/gamespy1/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/gamespy2/__init__.py b/opengsq/responses/gamespy2/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/jediknight/__init__.py b/opengsq/responses/jediknight/__init__.py
@@ -1,3 +1,5 @@
 from .info import Info
 from .status import Status
 from .jediknight_status import JediKnightStatus
+
+__all__ = ["Info", "Status", "JediKnightStatus"]
diff --git a/opengsq/responses/kaillera/__init__.py b/opengsq/responses/kaillera/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/killingfloor/__init__.py b/opengsq/responses/killingfloor/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/minecraft/__init__.py b/opengsq/responses/minecraft/__init__.py
@@ -1 +1,3 @@
 from .status_pre_17 import StatusPre17
+
+__all__ = ["StatusPre17"]
diff --git a/opengsq/responses/nadeo/__init__.py b/opengsq/responses/nadeo/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/palworld/__init__.py b/opengsq/responses/palworld/__init__.py
@@ -1,2 +1,4 @@
 from .status import Status
 from .player import Player
+
+__all__ = ["Status", "Player"]
diff --git a/opengsq/responses/quake1/__init__.py b/opengsq/responses/quake1/__init__.py
@@ -1,2 +1,4 @@
 from .player import Player
 from .status import Status
+
+__all__ = ["Player", "Status"]
diff --git a/opengsq/responses/quake2/__init__.py b/opengsq/responses/quake2/__init__.py
@@ -1,2 +1,4 @@
 from .player import Player
 from .status import Status
+
+__all__ = ["Player", "Status"]
diff --git a/opengsq/responses/raknet/__init__.py b/opengsq/responses/raknet/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/renegadex/__init__.py b/opengsq/responses/renegadex/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/samp/__init__.py b/opengsq/responses/samp/__init__.py
@@ -1,2 +1,4 @@
 from .player import Player
 from .status import Status
+
+__all__ = ["Player", "Status"]
diff --git a/opengsq/responses/satisfactory/__init__.py b/opengsq/responses/satisfactory/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/scum/__init__.py b/opengsq/responses/scum/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/source/__init__.py b/opengsq/responses/source/__init__.py
@@ -7,3 +7,15 @@
 from .source_info import SourceInfo
 from .vac import VAC
 from .visibility import Visibility
+
+__all__ = [
+    "Environment",
+    "ExtraDataFlag",
+    "GoldSourceInfo",
+    "PartialInfo",
+    "Player",
+    "ServerType",
+    "SourceInfo",
+    "VAC",
+    "Visibility",
+]
diff --git a/opengsq/responses/toxikk/__init__.py b/opengsq/responses/toxikk/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/udk/__init__.py b/opengsq/responses/udk/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/unreal2/__init__.py b/opengsq/responses/unreal2/__init__.py
@@ -1,2 +1,4 @@
 from .player import Player
 from .status import Status
+
+__all__ = ["Player", "Status"]
diff --git a/opengsq/responses/ut3/__init__.py b/opengsq/responses/ut3/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/vcmp/__init__.py b/opengsq/responses/vcmp/__init__.py
@@ -1,2 +1,4 @@
 from .player import Player
 from .status import Status
+
+__all__ = ["Player", "Status"]
diff --git a/opengsq/responses/w40kdow/__init__.py b/opengsq/responses/w40kdow/__init__.py
@@ -1 +1,3 @@
 from .status import Status
+
+__all__ = ["Status"]
diff --git a/opengsq/responses/warfork/__init__.py b/opengsq/responses/warfork/__init__.py
@@ -1 +1,3 @@
 from .player import Player
+
+__all__ = ["Player"]

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`from .source_rcon import SourceRcon`
	`2`	`+`
	`3`	`+__all__ = ["SourceRcon"]`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`from .status import Status`
	`2`	`+`
	`3`	`+__all__ = ["Status"]`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`from .matchmaking import Matchmaking`
	`2`	`+`
	`3`	`+__all__ = ["Matchmaking"]`