Specify interface and author for each module

Spelling out what is public in each module helps to futureproof the
project, and allows the main script to import the relevant names without
contravening best practices.

Buyer was missing from the main script's interface, despite being used
to call Solve. This has been fixed.
This commit is contained in:
Jeremy Saklad 2021-08-03 12:53:25 -05:00
parent ed9cde4b01
commit 9cfed0f839
Signed by: Jeremy Saklad
GPG Key ID: 9CA2149583EDBF84
10 changed files with 28 additions and 1 deletions

View File

@ -1,6 +1,6 @@
"""Use constraint programming to devise the optimal skeleton at the Bone Market in Fallen London.""" """Use constraint programming to devise the optimal skeleton at the Bone Market in Fallen London."""
__all__ = ['Declaration', 'DiplomatFascination', 'Fluctuation', 'OccasionalBuyer', 'Solve'] __all__ = ['Buyer', 'Declaration', 'DiplomatFascination', 'Fluctuation', 'OccasionalBuyer', 'Solve']
__author__ = "Jeremy Saklad" __author__ = "Jeremy Saklad"
import argparse import argparse

View File

@ -1,3 +1,6 @@
__all__ = ['Adjustment']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from data.costs import Cost from data.costs import Cost

View File

@ -1,3 +1,6 @@
__all__ = ['Appendage']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from data.costs import Cost from data.costs import Cost

View File

@ -1,3 +1,6 @@
__all__ = ['Buyer']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from data.costs import Cost from data.costs import Cost

View File

@ -1,3 +1,6 @@
__all__ = ['Cost']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from ortools.sat.python import cp_model from ortools.sat.python import cp_model

View File

@ -1,3 +1,6 @@
__all__ = ['Declaration']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from data.costs import Cost from data.costs import Cost

View File

@ -1,3 +1,6 @@
__all__ = ['Embellishment']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from data.costs import Cost from data.costs import Cost

View File

@ -1,3 +1,6 @@
__all__ = ['Skull']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from data.costs import Cost from data.costs import Cost

View File

@ -1,3 +1,6 @@
__all__ = ['Torso']
__author__ = "Jeremy Saklad"
from enum import Enum from enum import Enum
from data.costs import Cost from data.costs import Cost

View File

@ -1,3 +1,6 @@
__all__ = ['Action']
__author__ = "Jeremy Saklad"
class Action: class Action:
"""An action that affects a skeleton's qualities.""" """An action that affects a skeleton's qualities."""