xlogger-py 0.3.0__tar.gz

xlogger_py-0.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 elves / tango_util / python
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

xlogger_py-0.3.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: xlogger-py
+Version: 0.3.0
+Summary: logger
+Author: K.NAKADA
+Author-email: Kengo NAKADA <kengo.nakada@email.com>
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorlog
+Requires-Dist: coloredlogs
+Requires-Dist: sphinx
+Requires-Dist: myst-parser
+Requires-Dist: sphinx-autobuild
+Requires-Dist: sphinx-rtd-theme
+Requires-Dist: sphinxcontrib-napoleon
+Requires-Dist: linkify-it-py
+Dynamic: author
+Dynamic: license-file
+
+# x_logger
+
+[ohara-lab-su](https://ohara-lab-su.github.io/)/
+[x_logger](https://ohara-lab-su.github.io/x_logger/)
+
+## 名前の由来
+
+`daruma` 用 logger、`elves` 用の `el_logger` など、プロジェクトごとに
+作成していた logger の共通機能をまとめ、用途を限定しない logger として
+再構築したものが `x_logger` です。
+
+`x` は任意・汎用の用途を表しています。また、他に適当な名前が
+思いつかなかった、という単純な理由もあります。
+
+## はじめに
+
+`x_logger` は Python 標準の `logging` を基盤にした logger です。
+`logger_name` を logical logger の識別名として扱い、console、file、
+TimedRotatingFileHandler を簡単に構成できます。
+
+同じ `logger_name` は同じ named logger を表します。異なる
+`logger_name` は別の logger として扱われます。
+
+デバイス用途では、`logger_name` にデバイスクラス名を使用することを
+基本とします。これにより、ログ保存、multiprocessing、将来のログ閲覧
+サーバーで同じ logical logger 名を一貫して使用できます。
+
+## Single-process logger
+
+通常は `XLogger` を使用します。
+
+```python
+from x_logger.x_logger import XLogger
+
+logger = XLogger(
+    logger_name="Cobotta",
+    log_mode="rotating",
+    log_name="Cobotta.log",
+)
+
+logger.info("started")
+```
+
+`XLogger` のインスタンスを他のクラスへ渡して使用することもできます。
+ただし logger の論理的な識別はインスタンスではなく `logger_name` です。
+
+### log_mode
+
+`default` は console のみに出力します。
+
+`file` は指定したファイルと console の両方へ出力します。単独の
+ファイル保存用途として利用でき、デバイスサーバーやログ閲覧サーバーを
+必要としません。
+
+`rotating` または `rotate` は TimedRotatingFileHandler と console の
+両方へ出力します。rotation は midnight、保存数は `backup_count` で
+指定します。
+
+## Handler management
+
+XLogger が生成した handler には XLogger 管理用の識別情報を付与します。
+同じ `logger_name` を XLogger で再設定した場合は、以前の XLogger handler
+を閉じてから新しい構成へ置き換えます。
+
+これにより、XLogger を再生成したことで console handler や file handler
+が積み重なることを防ぎます。
+
+named logger は `propagate = False` とし、XLogger の出力が root logger を
+経由して再度 console へ出力される経路を遮断します。
+
+root logger の coloredlogs 設定はプロセス内で一度だけ行います。
+
+## Multiprocessing logger
+
+multiprocessing 用には別クラス `MultiProcessXLogger` を使用します。
+Single-process の `XLogger` と出力モード、logger name、level、format の
+考え方を共通化しています。
+
+```python
+from x_logger.multiprocess import MultiProcessXLogger
+
+logger = MultiProcessXLogger(
+    logger_name="Cobotta",
+    log_mode="rotating",
+    log_name="Cobotta.log",
+)
+```
+
+multiprocessing では各 process が file handler を持つ構成にはせず、
+各 process からの LogRecord を QueueHandler で owner process へ送ります。
+owner process の QueueListener だけが console/file/rotating handler を
+所有します。
+
+```text
+parent process ---\
+child process 1 ---+--> Queue --> QueueListener --> console
+child process 2 ---/                         |
+                                             +--> file / rotating file
+```
+
+この構成により、一つの logical logger に対する file 出力と rotation の
+所有者を一つに保ちます。
+
+`fork` では child process に継承された file handler を閉じ、QueueHandler
+経由へ切り替えます。`spawn` では復元された logger に QueueHandler を
+設定します。
+
+multiprocessing の処理、Queue、QueueListener、process 判定、終了処理は
+`multiprocess.py` に分離しています。
+
+## Logical logger とログ閲覧
+
+デバイスシステムでは、基本的にデバイスクラス名を `logger_name` として
+使用します。
+
+```text
+Cobotta
+  -> logger_name: Cobotta
+  -> log storage: <prefix>/Cobotta/...
+
+Camera
+  -> logger_name: Camera
+  -> log storage: <prefix>/Camera/...
+```
+
+将来のログ閲覧サーバーでは、この logical logger 名を基準に、現在の
+ログと rotation 済みログを gRPC 等から参照できる構成を想定します。
+
+XLogger はログの生成と保存を担当し、ログ閲覧サーバーは保存された
+logical log stream の公開を担当します。

xlogger_py-0.3.0/README.md

@@ -0,0 +1,130 @@
+# x_logger
+
+[ohara-lab-su](https://ohara-lab-su.github.io/)/
+[x_logger](https://ohara-lab-su.github.io/x_logger/)
+
+## 名前の由来
+
+`daruma` 用 logger、`elves` 用の `el_logger` など、プロジェクトごとに
+作成していた logger の共通機能をまとめ、用途を限定しない logger として
+再構築したものが `x_logger` です。
+
+`x` は任意・汎用の用途を表しています。また、他に適当な名前が
+思いつかなかった、という単純な理由もあります。
+
+## はじめに
+
+`x_logger` は Python 標準の `logging` を基盤にした logger です。
+`logger_name` を logical logger の識別名として扱い、console、file、
+TimedRotatingFileHandler を簡単に構成できます。
+
+同じ `logger_name` は同じ named logger を表します。異なる
+`logger_name` は別の logger として扱われます。
+
+デバイス用途では、`logger_name` にデバイスクラス名を使用することを
+基本とします。これにより、ログ保存、multiprocessing、将来のログ閲覧
+サーバーで同じ logical logger 名を一貫して使用できます。
+
+## Single-process logger
+
+通常は `XLogger` を使用します。
+
+```python
+from x_logger.x_logger import XLogger
+
+logger = XLogger(
+    logger_name="Cobotta",
+    log_mode="rotating",
+    log_name="Cobotta.log",
+)
+
+logger.info("started")
+```
+
+`XLogger` のインスタンスを他のクラスへ渡して使用することもできます。
+ただし logger の論理的な識別はインスタンスではなく `logger_name` です。
+
+### log_mode
+
+`default` は console のみに出力します。
+
+`file` は指定したファイルと console の両方へ出力します。単独の
+ファイル保存用途として利用でき、デバイスサーバーやログ閲覧サーバーを
+必要としません。
+
+`rotating` または `rotate` は TimedRotatingFileHandler と console の
+両方へ出力します。rotation は midnight、保存数は `backup_count` で
+指定します。
+
+## Handler management
+
+XLogger が生成した handler には XLogger 管理用の識別情報を付与します。
+同じ `logger_name` を XLogger で再設定した場合は、以前の XLogger handler
+を閉じてから新しい構成へ置き換えます。
+
+これにより、XLogger を再生成したことで console handler や file handler
+が積み重なることを防ぎます。
+
+named logger は `propagate = False` とし、XLogger の出力が root logger を
+経由して再度 console へ出力される経路を遮断します。
+
+root logger の coloredlogs 設定はプロセス内で一度だけ行います。
+
+## Multiprocessing logger
+
+multiprocessing 用には別クラス `MultiProcessXLogger` を使用します。
+Single-process の `XLogger` と出力モード、logger name、level、format の
+考え方を共通化しています。
+
+```python
+from x_logger.multiprocess import MultiProcessXLogger
+
+logger = MultiProcessXLogger(
+    logger_name="Cobotta",
+    log_mode="rotating",
+    log_name="Cobotta.log",
+)
+```
+
+multiprocessing では各 process が file handler を持つ構成にはせず、
+各 process からの LogRecord を QueueHandler で owner process へ送ります。
+owner process の QueueListener だけが console/file/rotating handler を
+所有します。
+
+```text
+parent process ---\
+child process 1 ---+--> Queue --> QueueListener --> console
+child process 2 ---/                         |
+                                             +--> file / rotating file
+```
+
+この構成により、一つの logical logger に対する file 出力と rotation の
+所有者を一つに保ちます。
+
+`fork` では child process に継承された file handler を閉じ、QueueHandler
+経由へ切り替えます。`spawn` では復元された logger に QueueHandler を
+設定します。
+
+multiprocessing の処理、Queue、QueueListener、process 判定、終了処理は
+`multiprocess.py` に分離しています。
+
+## Logical logger とログ閲覧
+
+デバイスシステムでは、基本的にデバイスクラス名を `logger_name` として
+使用します。
+
+```text
+Cobotta
+  -> logger_name: Cobotta
+  -> log storage: <prefix>/Cobotta/...
+
+Camera
+  -> logger_name: Camera
+  -> log storage: <prefix>/Camera/...
+```
+
+将来のログ閲覧サーバーでは、この logical logger 名を基準に、現在の
+ログと rotation 済みログを gRPC 等から参照できる構成を想定します。
+
+XLogger はログの生成と保存を担当し、ログ閲覧サーバーは保存された
+logical log stream の公開を担当します。

xlogger_py-0.3.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+#name = "x_logger"
+name = "xlogger-py"
+
+version = "0.3.0"
+
+description = "logger"
+authors = [
+  { name="Kengo NAKADA", email="kengo.nakada@email.com" }
+]
+readme = "README.md"
+#requires-python = ">=3.8"
+requires-python = ">=3.7"
+
+dependencies = [
+"colorlog",
+"coloredlogs",
+#
+"sphinx",
+"myst-parser",
+"sphinx-autobuild",
+"sphinx-rtd-theme",
+"sphinxcontrib-napoleon",
+"linkify-it-py"
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+# ここでpytestのiniと同じようにオプションが書ける
+# 例えばテストマーク、フィルタ、カバレッジなども追記可能
+
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"

xlogger_py-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xlogger_py-0.3.0/setup.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python
+
+# Copyright (C) 2014,2015 K.NAKADA
+
+__author__ = "Kengo NAKADA"
+__maintainer__ = "Kengo NAKADA"
+__credits__ = ["Kengo NAKADA"]
+__email__ = "kengo.nakada@gmail.com"
+# __email__ = "kengo.nakada@spring8.or.jp"
+__copyright__ = "Copyright 2014-2018 Kengo NAKADA"
+__license__ = "Apache2"
+__status__ = "alpha"
+
+# __version__    = "0.0.1"
+# __license__    = "MIT"
+
+from setuptools import setup, find_packages
+import glob
+import re
+
+def get_version_from_toml(toml_path):
+    """
+    Python 3.6 向け: TOML ファイルから version 番号を正規表現で抽出。
+    [project] セクション内でも対応。
+    """
+    with open(toml_path, encoding="utf-8") as f:
+        text = f.read()
+    match = re.search(r'version\s*=\s*["\']([^"\']+)["\']', text)
+    if not match:
+        raise RuntimeError("TOML ファイル内に version が見つかりません。")
+    return match.group(1)
+
+__version__ = get_version_from_toml("pyproject.toml")
+
+long_description = "x_logger"
+
+# if os.path.exists('README.md'):
+#    long_description = open('README.md').read()
+
+package_src_dir = "x_logger"
+packages = find_packages("src")
+
+setup(
+    name="x_logger",
+    packages=packages,
+    package_dir={"": "src"},
+    # include_package_data=True,
+    # package_data = { '': ['LICENSE.txt', 'README.md']},
+    # data_files=[(package_src_dir, files)],
+    # scripts=script,
+    version=__version__,
+    description="XLogger",
+    long_description=long_description,
+    author="K.NAKADA",
+    # author_email = ['kengo.nakada@gmail.com','kengo.nakada@spring8.or.jp'],
+    # author_email = 'kengo.nakada@gmail.com',
+    # author_email='kengo.nakada@spring8.or.jp',
+    author_email="kengo.nakada@gmail.com",
+    license="Apache2.0",
+    install_requires=[],
+    #       platforms = ['linux','OSX','Window'],
+    #       classifiers = [
+    #           'Programming Language :: Python :: 2.7',
+    #           'Intended Audience :: Science/Research',
+    #           'License :: OSI Approved :: MIT License'
+    #           ]
+)

xlogger_py-0.3.0/src/x_logger/__init__.py

@@ -0,0 +1,2 @@
+from x_logger.x_logger import XLogger
+from x_logger.util import get_silent_logger