Introduce sonic-py-common package #5003
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| SPATH := $($(SONIC_PY_COMMON_PY2)_SRC_PATH) | ||
| DEP_FILES := $(SONIC_COMMON_FILES_LIST) rules/sonic-py-common.mk rules/sonic-py-common.dep | ||
| DEP_FILES += $(SONIC_COMMON_BASE_FILES_LIST) | ||
| DEP_FILES += $(shell git ls-files $(SPATH)) | ||
|
|
||
| $(SONIC_PY_COMMON_PY2)_CACHE_MODE := GIT_CONTENT_SHA | ||
| $(SONIC_PY_COMMON_PY2)_DEP_FLAGS := $(SONIC_COMMON_FLAGS_LIST) | ||
| $(SONIC_PY_COMMON_PY2)_DEP_FILES := $(DEP_FILES) | ||
|
There was a problem hiding this comment. @xumia Could you help review? |
||
|
|
||
| $(SONIC_PY_COMMON_PY3)_CACHE_MODE := GIT_CONTENT_SHA | ||
| $(SONIC_PY_COMMON_PY3)_DEP_FLAGS := $(SONIC_COMMON_FLAGS_LIST) | ||
| $(SONIC_PY_COMMON_PY3)_DEP_FILES := $(DEP_FILES) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # SONIC_PY_COMMON_PY2 package | ||
|
|
||
| SONIC_PY_COMMON_PY2 = sonic_py_common-1.0-py2-none-any.whl | ||
| $(SONIC_PY_COMMON_PY2)_SRC_PATH = $(SRC_PATH)/sonic-py-common | ||
| $(SONIC_PY_COMMON_PY2)_DEPENDS += $(SWSSSDK_PY2) | ||
| $(SONIC_PY_COMMON_PY2)_PYTHON_VERSION = 2 | ||
| SONIC_PYTHON_WHEELS += $(SONIC_PY_COMMON_PY2) | ||
|
|
||
| # SONIC_PY_COMMON_PY3 package | ||
|
|
||
| SONIC_PY_COMMON_PY3 = sonic_py_common-1.0-py3-none-any.whl | ||
| $(SONIC_PY_COMMON_PY3)_SRC_PATH = $(SRC_PATH)/sonic-py-common | ||
| $(SONIC_PY_COMMON_PY3)_DEPENDS += $(SWSSSDK_PY3) | ||
| $(SONIC_PY_COMMON_PY3)_PYTHON_VERSION = 3 | ||
| SONIC_PYTHON_WHEELS += $(SONIC_PY_COMMON_PY3) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,5 +2,5 @@ | |
|
|
||
| SONIC_THERMALCTLD = python-sonic-thermalctld_1.0-1_all.deb | ||
| $(SONIC_THERMALCTLD)_SRC_PATH = $(SRC_PATH)/sonic-platform-daemons/sonic-thermalctld | ||
| $(SONIC_THERMALCTLD)_WHEEL_DEPENDS = $(SONIC_PY_COMMON_PY2) $(SONIC_DAEMON_BASE_PY2) | ||
|
There was a problem hiding this comment.
I see some code duplication in both repo. Can we merge 2 into 1? #Pending There was a problem hiding this comment. That's the ultimate goal. After this merges, I intend to shift all code away from sonic-daemon-base and sonic-device-util, and remove them completely in separate PRs. Please read the "Next Steps" in my description above and see the linked issue: #4999 |
||
| SONIC_PYTHON_STDEB_DEBS += $(SONIC_THERMALCTLD) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| from setuptools import setup | ||
|
|
||
| dependencies = [ | ||
| 'natsort', | ||
| 'pyyaml', | ||
| 'swsssdk>=2.0.1', | ||
| ] | ||
|
|
||
| high_performance_deps = [ | ||
| 'swsssdk[high_perf]>=2.0.1', | ||
| ] | ||
|
|
||
| setup( | ||
| name='sonic-py-common', | ||
| version='1.0', | ||
| description='Common Python libraries for SONiC', | ||
| license='Apache 2.0', | ||
| author='SONiC Team', | ||
| author_email='linuxnetdev@microsoft.com', | ||
| url='https://github.com/Azure/SONiC', | ||
| maintainer='Joe LeVeque', | ||
| maintainer_email='jolevequ@microsoft.com', | ||
| install_requires=dependencies, | ||
| extras_require={ | ||
| 'high_perf': high_performance_deps, | ||
| }, | ||
| packages=[ | ||
| 'sonic_py_common', | ||
| ], | ||
| classifiers=[ | ||
| 'Intended Audience :: Developers', | ||
| 'Operating System :: Linux', | ||
| 'Programming Language :: Python :: 2.7', | ||
| 'Programming Language :: Python :: 3.5', | ||
| 'Programming Language :: Python', | ||
| ], | ||
| keywords='SONiC sonic PYTHON python COMMON common', | ||
| ) | ||
|
|
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import imp | ||
| import signal | ||
| import sys | ||
|
|
||
| from . import device_info | ||
| from .logger import Logger | ||
|
|
||
| # | ||
| # Constants ==================================================================== | ||
| # | ||
| REDIS_TIMEOUT_MSECS = 0 | ||
|
|
||
| EEPROM_MODULE_NAME = 'eeprom' | ||
| EEPROM_CLASS_NAME = 'board' | ||
|
|
||
| # | ||
| # Helper functions ============================================================= | ||
| # | ||
|
|
||
| def db_connect(db_name): | ||
| from swsscommon import swsscommon | ||
| return swsscommon.DBConnector(db_name, REDIS_TIMEOUT_MSECS, True) | ||
|
|
||
| # | ||
| # DaemonBase =================================================================== | ||
| # | ||
|
|
||
| class DaemonBase(Logger): | ||
| def __init__(self, log_identifier): | ||
| super(DaemonBase, self).__init__(log_identifier, Logger.LOG_FACILITY_DAEMON) | ||
|
|
||
| # Register our default signal handlers, unless the signal already has a | ||
| # handler registered, most likely from a subclass implementation | ||
| if not signal.getsignal(signal.SIGHUP): | ||
| signal.signal(signal.SIGHUP, self.signal_handler) | ||
| if not signal.getsignal(signal.SIGINT): | ||
| signal.signal(signal.SIGINT, self.signal_handler) | ||
| if not signal.getsignal(signal.SIGTERM): | ||
| signal.signal(signal.SIGTERM, self.signal_handler) | ||
|
|
||
| # Default signal handler; can be overridden by subclass | ||
| def signal_handler(self, sig, frame): | ||
| if sig == signal.SIGHUP: | ||
| log_info("DaemonBase: Caught SIGHUP - ignoring...") | ||
| elif sig == signal.SIGINT: | ||
| log_info("DaemonBase: Caught SIGINT - exiting...") | ||
| sys.exit(128 + sig) | ||
| elif sig == signal.SIGTERM: | ||
| log_info("DaemonBase: Caught SIGTERM - exiting...") | ||
| sys.exit(128 + sig) | ||
| else: | ||
| log_warning("DaemonBase: Caught unhandled signal '{}'".format(sig)) | ||
|
|
||
| # Loads platform specific platform module from source | ||
| def load_platform_util(self, module_name, class_name): | ||
| platform_util = None | ||
|
|
||
| # Get path to platform and hwsku | ||
| (platform_path, hwsku_path) = device_info.get_path_to_platform_and_hwsku() | ||
|
|
||
| try: | ||
| module_file = "/".join([platform_path, "plugins", module_name + ".py"]) | ||
| module = imp.load_source(module_name, module_file) | ||
| except IOError as e: | ||
| raise IOError("Failed to load platform module '%s': %s" % (module_name, str(e))) | ||
|
|
||
| try: | ||
| platform_util_class = getattr(module, class_name) | ||
| # board class of eeprom requires 4 paramerters, need special treatment here. | ||
| if module_name == EEPROM_MODULE_NAME and class_name == EEPROM_CLASS_NAME: | ||
| platform_util = platform_util_class('','','','') | ||
| else: | ||
| platform_util = platform_util_class() | ||
| except AttributeError as e: | ||
| raise AttributeError("Failed to instantiate '%s' class: %s" % (class_name, str(e))) | ||
|
|
||
| return platform_util | ||
|
|
||
| # Runs daemon | ||
| def run(self): | ||
| raise NotImplementedError() |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pyc should always be ignored, so suggest consolidate them into one line.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this makes sense in a separate PR designed for general cleanup purposes, as it touches more than this new package. Please open an issue to track it.