state.py

"""
Global runtime variables.
"""

neededPubkeys = {}

extPort = None
"""For UPnP"""

socksIP = None
"""for Tor hidden service"""

appdata = ""
"""holds the location of the application data storage directory"""

shutdown = 0
"""
Set to 1 by the `.shutdown.doCleanShutdown` function.
Used to tell the threads to exit.
"""

# Component control flags - set on startup, do not change during runtime
#     The defaults are for standalone GUI (default operating mode)
enableNetwork = True
"""enable network threads"""
enableObjProc = True
"""enable object processing thread"""
enableAPI = True
"""enable API (if configured)"""
enableGUI = True
"""enable GUI (QT or ncurses)"""
enableSTDIO = False
"""enable STDIO threads"""
enableKivy = False
"""enable kivy app and test cases"""
curses = False

maximumNumberOfHalfOpenConnections = 0

maximumLengthOfTimeToBotherResendingMessages = 0

ownAddresses = {}

discoveredPeers = {}

kivy = False

kivyapp = None

testmode = False

clientHasReceivedIncomingConnections = False
"""used by API command clientStatus"""

numberOfMessagesProcessed = 0
numberOfBroadcastsProcessed = 0
numberOfPubkeysProcessed = 0

statusIconColor = "red"
"""
GUI status icon color
.. note:: bad style, refactor it
"""

ackdataForWhichImWatching = {}

thisapp = None
"""Singleton instance"""

backend_py3_compatible = False


class Placeholder(object):  # pylint:disable=too-few-public-methods
    """Placeholder class"""

    def __init__(self, className):
        self.className = className

    def __getattr__(self, name):
        self._raise()

    def __setitem__(self, key, value):
        self._raise()

    def __getitem__(self, key):
        self._raise()

    def _raise(self):
        raise NotImplementedError(
            "Probabaly you forgot to initialize state variable for {}".format(
                self.className
            )
        )


Inventory = Placeholder("Inventory")