log-ctrl 0.0.1__py3-none-any.whl

log_ctrl/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-

log_ctrl/log_ctrl.py

@@ -0,0 +1,248 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from __future__ import annotations
+
+from datetime import datetime
+from pathlib import Path
+from typing import List, Optional, Union
+
+
+class LogCtrl:
+    """ログディレクトリをローカルで扱う制御クラス。"""
+
+    def __init__(
+        self,
+        log_dir: Union[str, Path],
+        encoding: str = "utf-8",
+    ) -> None:
+        self._log_dir = Path(log_dir).expanduser().resolve()
+        self._encoding = str(encoding)
+
+        if not self._log_dir.is_dir():
+            raise NotADirectoryError(
+                "log directory does not exist: " + str(self._log_dir)
+            )
+
+    def log_names(self) -> List[str]:
+        """実在する .log / .log.YYYY-MM-DD ファイルから log_name 一覧を返す。"""
+        names = set()
+
+        for path in self._log_dir.iterdir():
+            if not path.is_file():
+                continue
+
+            parsed = self._parse_log_filename(path.name)
+            if parsed is None:
+                continue
+
+            log_name, _date_value = parsed
+            names.add(log_name)
+
+        return sorted(names)
+
+    def dates(
+        self,
+        log_name: str,
+    ) -> List[str]:
+        """指定 log_name に実在するローテーション済み日付一覧を返す。"""
+        name = self._validate_log_name(log_name)
+        prefix = name + ".log."
+        values = set()
+
+        for path in self._log_dir.iterdir():
+            if not path.is_file():
+                continue
+
+            if not path.name.startswith(prefix):
+                continue
+
+            date_value = path.name[len(prefix):]
+
+            if self._is_date(date_value):
+                values.add(date_value)
+
+        return sorted(values, reverse=True)
+
+    def raw_files(self) -> List[str]:
+        """トラブル調査用に log_dir 以下の全ファイル相対パスをそのまま返す。"""
+        files = []
+
+        for path in self._log_dir.rglob("*"):
+            if not path.is_file():
+                continue
+
+            files.append(
+                path.relative_to(self._log_dir).as_posix()
+            )
+
+        return sorted(files)
+
+    def _resolve_raw_path(
+        self,
+        relative_path: str,
+    ) -> Path:
+        if not isinstance(relative_path, str):
+            raise ValueError("relative_path must be a non-empty string")
+
+        if relative_path == "":
+            raise ValueError("relative_path must be a non-empty string")
+
+        relative = Path(relative_path)
+
+        if relative.is_absolute():
+            raise ValueError("relative_path must be relative to log_dir")
+
+        path = (self._log_dir / relative).resolve()
+
+        try:
+            path.relative_to(self._log_dir)
+        except ValueError:
+            raise ValueError("relative_path must stay inside log_dir")
+
+        if not path.is_file():
+            raise FileNotFoundError(
+                "file does not exist: " + str(path)
+            )
+
+        return path
+
+    def exists(
+        self,
+        log_name: str,
+        date: Optional[str] = None,
+    ) -> bool:
+        """指定した現在ログまたは日付ログが実在するか返す。"""
+        try:
+            path = self._resolve_log_path(
+                log_name,
+                date,
+                require_exists=False,
+            )
+        except (TypeError, ValueError):
+            return False
+
+        return path.is_file()
+
+    def tail(
+        self,
+        log_name: str,
+        lines: int = 100,
+        date: Optional[str] = None,
+    ) -> str:
+        """指定ログの末尾を文字列で返す。"""
+        if isinstance(lines, bool):
+            raise ValueError("lines must be a positive integer")
+
+        if not isinstance(lines, int):
+            raise ValueError("lines must be a positive integer")
+
+        if lines <= 0:
+            raise ValueError("lines must be a positive integer")
+
+        path = self._resolve_log_path(log_name, date)
+        block_size = 8192
+        data = b""
+
+        with path.open("rb") as file_obj:
+            file_obj.seek(0, 2)
+            position = file_obj.tell()
+
+            while position > 0 and data.count(b"\n") <= lines:
+                read_size = min(block_size, position)
+                position -= read_size
+                file_obj.seek(position)
+                data = file_obj.read(read_size) + data
+
+        text = data.decode(self._encoding)
+        return "".join(text.splitlines(keepends=True)[-lines:])
+
+    def _resolve_log_path(
+        self,
+        log_name: str,
+        date: Optional[str] = None,
+        require_exists: bool = True,
+    ) -> Path:
+        name = self._validate_log_name(log_name)
+
+        if date is None:
+            filename = name + ".log"
+        else:
+            self._validate_date(date)
+            filename = name + ".log." + date
+
+        path = self._log_dir / filename
+
+        if require_exists:
+            if not path.is_file():
+                raise FileNotFoundError(
+                    "log file does not exist: " + str(path)
+                )
+
+        return path
+
+    @staticmethod
+    def _validate_log_name(log_name: str) -> str:
+        if not isinstance(log_name, str):
+            raise ValueError("log_name must be a non-empty string")
+
+        if log_name == "":
+            raise ValueError("log_name must be a non-empty string")
+
+        if Path(log_name).name != log_name:
+            raise ValueError("log_name must not contain a path")
+
+        if log_name == "." or log_name == "..":
+            raise ValueError("log_name must not contain a path")
+
+        if ".log" in log_name:
+            raise ValueError("log_name must not contain '.log'")
+
+        return log_name
+
+    @staticmethod
+    def _validate_date(value: str) -> None:
+        if not isinstance(value, str):
+            raise TypeError("date must be a string in YYYY-MM-DD format")
+
+        try:
+            parsed = datetime.strptime(value, "%Y-%m-%d")
+        except ValueError:
+            raise ValueError("date must be in YYYY-MM-DD format")
+
+        if parsed.strftime("%Y-%m-%d") != value:
+            raise ValueError("date must be in YYYY-MM-DD format")
+
+    @staticmethod
+    def _is_date(value: str) -> bool:
+        try:
+            LogCtrl._validate_date(value)
+        except (TypeError, ValueError):
+            return False
+
+        return True
+
+    @staticmethod
+    def _parse_log_filename(filename: str):
+        if filename.endswith(".log"):
+            log_name = filename[:-4]
+
+            if log_name != "":
+                return log_name, None
+
+            return None
+
+        marker = ".log."
+
+        if marker not in filename:
+            return None
+
+        log_name, date_value = filename.rsplit(marker, 1)
+
+        if log_name == "":
+            return None
+
+        if not LogCtrl._is_date(date_value):
+            return None
+
+        return log_name, date_value

log_ctrl/server_grpc/__init__.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from typing import Any, Optional, Union
+from pathlib import Path
+
+from grpc_frame import DeviceProxy, register_device_proxy
+
+from log_ctrl.server_grpc.async_log_grpc_client import AsyncLogGrpcClient
+from log_ctrl.server_grpc.sync_log_grpc_client import SyncLogGrpcClient
+
+DEVICE_PROXY_NAME = "log"
+DEVICE_PROXY_ALIASES = [
+    "Log",
+    "LogCtrl",
+    "log_grpc",
+]
+
+register_device_proxy(
+    DEVICE_PROXY_NAME,
+    async_client_cls=AsyncLogGrpcClient,
+    sync_client_cls=SyncLogGrpcClient,
+    default_async_mode=False,
+    aliases=DEVICE_PROXY_ALIASES,
+)
+
+
+def log_grpc_server(
+        *,
+        grpc_host: str,
+        grpc_port: int,
+        log_dir: Union[str, Path],
+        encoding: str = "utf-8",
+        chunk_size: int = 256 * 1024,
+        logger: Optional[Any] = None,
+        log_level: Optional[str] = None,
+) -> None:
+    from log_ctrl.server_grpc.log_grpc_server import log_grpc_server as _server
+
+    _server(
+        grpc_host=grpc_host,
+        grpc_port=grpc_port,
+        log_dir=log_dir,
+        encoding=encoding,
+        chunk_size=chunk_size,
+        logger=logger,
+        log_level=log_level,
+    )
+
+
+def log_server(
+        *,
+        grpc_host: str,
+        grpc_port: int,
+        log_dir: Union[str, Path],
+        encoding: str = "utf-8",
+        chunk_size: int = 256 * 1024,
+        logger: Optional[Any] = None,
+        log_level: Optional[str] = None,
+) -> None:
+    log_grpc_server(
+        grpc_host=grpc_host,
+        grpc_port=grpc_port,
+        log_dir=log_dir,
+        encoding=encoding,
+        chunk_size=chunk_size,
+        logger=logger,
+        log_level=log_level,
+    )
+
+
+__all__ = [
+    "DEVICE_PROXY_NAME",
+    "DEVICE_PROXY_ALIASES",
+    "DeviceProxy",
+    "AsyncLogGrpcClient",
+    "SyncLogGrpcClient",
+    "log_grpc_server",
+    "log_server",
+]

log_ctrl/server_grpc/async_log_grpc_client.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from __future__ import annotations
+
+import asyncio
+from typing import Any, Optional, Sequence, Tuple
+
+from grpc_frame import AsyncGrpcClient
+
+
+class AsyncLogGrpcClient(AsyncGrpcClient):
+    """ログサーバー用 AsyncGrpcClient。"""
+
+    def __init__(
+        self,
+        server_ip: str,
+        server_port: int,
+        timeout_sec: Optional[float] = None,
+        logger: Optional[Any] = None,
+        log_level: Optional[str] = None,
+        grpc_options: Optional[Sequence[Tuple[str, Any]]] = None,
+        set_timeout_sec: Optional[float] = None,
+    ) -> None:
+        if timeout_sec is not None and set_timeout_sec is not None:
+            raise ValueError(
+                "timeout_sec and set_timeout_sec cannot be specified together"
+            )
+
+        effective_timeout_sec = set_timeout_sec
+
+        if timeout_sec is not None:
+            effective_timeout_sec = timeout_sec
+
+        super().__init__(
+            server_ip=server_ip,
+            server_port=server_port,
+            timeout_sec=effective_timeout_sec,
+            logger=logger,
+            log_level=log_level,
+            grpc_options=grpc_options,
+        )
+
+    def _read_sync(
+        self,
+        log_name: str,
+        date: Optional[str] = None,
+    ) -> bytes:
+        data = bytearray()
+
+        for chunk in self.stream_call(
+            "read",
+            log_name,
+            date=date,
+        ):
+            data.extend(chunk)
+
+        return bytes(data)
+
+    def _read_raw_sync(
+        self,
+        relative_path: str,
+    ) -> bytes:
+        data = bytearray()
+
+        for chunk in self.stream_call(
+            "read_raw",
+            relative_path,
+        ):
+            data.extend(chunk)
+
+        return bytes(data)
+
+    async def read(
+        self,
+        log_name: str,
+        date: Optional[str] = None,
+    ) -> bytes:
+        loop = asyncio.get_running_loop()
+        return await loop.run_in_executor(
+            None,
+            self._read_sync,
+            log_name,
+            date,
+        )
+
+    async def read_raw(
+        self,
+        relative_path: str,
+    ) -> bytes:
+        loop = asyncio.get_running_loop()
+        return await loop.run_in_executor(
+            None,
+            self._read_raw_sync,
+            relative_path,
+        )

log_ctrl/server_grpc/log_grpc_server.py

@@ -0,0 +1,137 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from __future__ import annotations
+
+import time
+from pathlib import Path
+from typing import Any, Iterator, Optional, Union
+
+import grpc
+from grpc import channel_ready_future
+
+from grpc_frame.grpc_server import create_grpc_server
+
+from log_ctrl.log_ctrl import LogCtrl
+
+
+class _LogStream:
+    """LogCtrl のログファイル本体を StreamCall 用チャンクとして返す。"""
+
+    def __init__(
+        self,
+        ctrl: LogCtrl,
+        chunk_size: int = 256 * 1024,
+    ) -> None:
+        if isinstance(chunk_size, bool):
+            raise ValueError("chunk_size must be a positive integer")
+
+        if not isinstance(chunk_size, int):
+            raise ValueError("chunk_size must be a positive integer")
+
+        if chunk_size <= 0:
+            raise ValueError("chunk_size must be a positive integer")
+
+        self._ctrl = ctrl
+        self._chunk_size = chunk_size
+
+    def read(
+        self,
+        log_name: str,
+        date: Optional[str] = None,
+    ) -> Iterator[bytes]:
+        path = self._ctrl._resolve_log_path(log_name, date)
+
+        with path.open("rb") as file_obj:
+            while True:
+                chunk = file_obj.read(self._chunk_size)
+
+                if not chunk:
+                    break
+
+                yield chunk
+
+    def read_raw(
+        self,
+        relative_path: str,
+    ) -> Iterator[bytes]:
+        path = self._ctrl._resolve_raw_path(relative_path)
+
+        with path.open("rb") as file_obj:
+            while True:
+                chunk = file_obj.read(self._chunk_size)
+
+                if not chunk:
+                    break
+
+                yield chunk
+
+
+def log_grpc_server(
+    *,
+    grpc_host: str,
+    grpc_port: int,
+    log_dir: Union[str, Path],
+    encoding: str = "utf-8",
+    chunk_size: int = 256 * 1024,
+    logger: Optional[Any] = None,
+    log_level: Optional[str] = None,
+) -> None:
+    """LogCtrl を grpc_frame 上で公開するログサーバーを起動する。"""
+    if logger is None:
+        import logging
+
+        if log_level is None:
+            log_level = "INFO"
+
+        logging.basicConfig(level=log_level.upper())
+        logger = logging.getLogger(__name__)
+
+    ctrl = LogCtrl(
+        log_dir=log_dir,
+        encoding=encoding,
+    )
+
+    stream_obj = _LogStream(
+        ctrl=ctrl,
+        chunk_size=chunk_size,
+    )
+
+    server = create_grpc_server(
+        ctrl_obj=ctrl,
+        stream_obj=stream_obj,
+        logger=logger,
+        log_level=log_level,
+        max_workers=10,
+    )
+
+    bind_addr = str(grpc_host) + ":" + str(grpc_port)
+
+    ret = server.add_insecure_port(bind_addr)
+
+    if ret == 0:
+        raise RuntimeError("bind failed: " + bind_addr)
+
+    logger.info("gRPC bind OK: " + bind_addr)
+
+    server.start()
+
+    ch = grpc.insecure_channel(bind_addr)
+    channel_ready_future(ch).result(timeout=2.0)
+    ch.close()
+
+    logger.info("gRPC self-check OK")
+
+    try:
+        while True:
+            time.sleep(1)
+
+    except KeyboardInterrupt:
+        logger.info("KeyboardInterrupt")
+
+    finally:
+        server.stop(grace=None)
+        logger.info("gRPC server stopped")
+
+
+log_server = log_grpc_server

log_ctrl/server_grpc/sync_log_grpc_client.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from __future__ import annotations
+
+from typing import Any, Optional, Sequence, Tuple
+
+from grpc_frame import SyncGrpcClient
+
+
+class SyncLogGrpcClient(SyncGrpcClient):
+    """ログサーバー用 SyncGrpcClient。"""
+
+    def __init__(
+        self,
+        server_ip: str,
+        server_port: int,
+        timeout_sec: Optional[float] = None,
+        logger: Optional[Any] = None,
+        log_level: Optional[str] = None,
+        grpc_options: Optional[Sequence[Tuple[str, Any]]] = None,
+        set_timeout_sec: Optional[float] = None,
+    ) -> None:
+        if timeout_sec is not None and set_timeout_sec is not None:
+            raise ValueError(
+                "timeout_sec and set_timeout_sec cannot be specified together"
+            )
+
+        effective_timeout_sec = set_timeout_sec
+
+        if timeout_sec is not None:
+            effective_timeout_sec = timeout_sec
+
+        super().__init__(
+            server_ip=server_ip,
+            server_port=server_port,
+            timeout_sec=effective_timeout_sec,
+            logger=logger,
+            log_level=log_level,
+            grpc_options=grpc_options,
+        )
+
+    def read(
+        self,
+        log_name: str,
+        date: Optional[str] = None,
+    ) -> bytes:
+        data = bytearray()
+
+        for chunk in self.stream_call(
+            "read",
+            log_name,
+            date=date,
+        ):
+            data.extend(chunk)
+
+        return bytes(data)
+    def read_raw(
+        self,
+        relative_path: str,
+    ) -> bytes:
+        data = bytearray()
+
+        for chunk in self.stream_call(
+            "read_raw",
+            relative_path,
+        ):
+            data.extend(chunk)
+
+        return bytes(data)
+

log_ctrl-0.0.1.dist-info/METADATA

@@ -0,0 +1,414 @@
+Metadata-Version: 2.4
+Name: log_ctrl
+Version: 0.0.1
+Summary: gRPC server and proxy for reading x_logger rotating log files by device class.
+Author-email: Kengo NAKADA <kengo.nakada@email.com>
+License:                                  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.
+        
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xlogger-py
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: linkify-it-py; extra == "docs"
+Requires-Dist: grpcio; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# log_ctrl
+
+[![en](https://img.shields.io/badge/lang-en-red.svg)](https://github.com/ohara-lab-su/log_ctrl/blob/main/README.en.md)
+[![ja](https://img.shields.io/badge/lang-ja-yellow.svg)](https://github.com/ohara-lab-su/log_ctrl/blob/main/README.md)
+
+`log_ctrl`
+は、指定したログディレクトリに保存されているログファイルを、`grpc_frame`
+を使ってネットワーク越しに参照するためのパッケージです。
+
+ログを書き込む側の DeviceServer やアプリケーションにはログ取得 RPC
+を追加しません。`log_ctrl` は既存のログファイルを read-only
+で参照する独立した gRPC サーバーとして動作します。
+
+``` text
+application / DeviceServer
+        │
+        │ write
+        ▼
+C:\opt\ese774\log
+├── cobotta4_server.log
+├── cobotta4_server.log.2026-04-06
+├── cobotta4_server2.log
+└── cobotta4_server2.log.2026-06-16
+        ▲
+        │ read only
+        │
+     LogCtrl
+        │
+        ▼
+ log gRPC server
+        │
+        ▼
+DeviceProxy("log", ...)
+```
+
+## ログ名
+
+`log_ctrl` では、`.log` より前の部分を `log_name` と呼びます。
+
+``` text
+cobotta4_server.log
+^^^^^^^^^^^^^^^
+   log_name
+```
+
+ローテーション済みログは次の形式です。
+
+``` text
+<log_name>.log.YYYY-MM-DD
+```
+
+`log_name` は DeviceServer
+名やデバイスクラス名と一致する必要はありません。`log_ctrl`
+はファイル名として存在する `log_name` をそのまま扱います。
+
+## 主な機能
+
+- `log_names()` : 実在するログファイルから `log_name` 一覧を取得
+- `dates(log_name)` : 指定した `log_name`
+  のローテーション日付一覧を取得
+- `exists(log_name, date=None)` : 現在ログまたは指定日ログの存在確認
+- `tail(log_name, lines=100, date=None)` : ログ末尾を文字列で取得
+- `raw_files()` : ログディレクトリ以下の全ファイルを相対パスで列挙
+- `read(log_name, date=None)` : ログファイル本体を `bytes` で取得
+- `read_raw(relative_path)` : `raw_files()` で確認した任意ファイルを
+  `bytes` で取得
+
+大きなログファイルは `grpc_frame` の `StreamCall`
+を使ってチャンク転送します。利用側ではストリーム処理を直接扱う必要はなく、`read()`
+/ `read_raw()` が受信したチャンクを結合して `bytes` として返します。
+
+## インストール
+
+`grpc_frame` を利用可能な環境でインストールします。
+
+``` bash
+python -m pip install .
+```
+
+開発時は次のように editable install できます。
+
+``` bash
+python -m pip install -e .
+```
+
+## LogServer の起動
+
+``` python
+from log_ctrl.server_grpc import log_grpc_server
+
+GRPC_HOST = "0.0.0.0"
+GRPC_PORT = 50060
+LOG_DIR = r"C:\opt\ese774\log"
+
+log_grpc_server(
+    grpc_host=GRPC_HOST,
+    grpc_port=GRPC_PORT,
+    log_dir=LOG_DIR,
+)
+```
+
+`logger` を省略した場合は標準の `logging` が使用されます。既存の logger
+を使用する場合は `logger=` で渡せます。
+
+## クライアント
+
+`grpc_frame` の透過クライアントとして `DeviceProxy` を使用します。
+
+``` python
+from log_ctrl.server_grpc import DeviceProxy
+
+client = DeviceProxy(
+    "log",
+    server_ip="127.0.0.1",
+    server_port=50060,
+    set_timeout_sec=10.0,
+    async_mode=False,
+)
+
+try:
+    log_names = client.log_names()
+    print(log_names)
+
+    if len(log_names) > 0:
+        log_name = log_names[0]
+
+        print(client.dates(log_name))
+
+        if client.exists(log_name):
+            data = client.read(log_name)
+            print(len(data))
+
+finally:
+    client.close()
+```
+
+`log_names()` で返される名前は、現在の `<log_name>.log`
+が存在する名前だけとは限りません。ローテーション済みファイルだけが残っている場合も一覧に含まれます。現在ログを読む前に必要に応じて
+`exists(log_name)` を確認してください。
+
+## API
+
+``` python
+client.log_names()
+client.dates(log_name)
+
+client.exists(log_name)
+client.exists(log_name, date="2026-04-06")
+
+client.tail(log_name, lines=100)
+client.tail(log_name, lines=100, date="2026-04-06")
+
+client.raw_files()
+
+client.read(log_name)
+client.read(log_name, date="2026-04-06")
+
+client.read_raw("cobotta4_server.log.2026-04-06")
+```
+
+`read()` と `read_raw()` の戻り値は `bytes`
+です。ログを文字列として扱う場合は、使用している文字コードに合わせてクライアント側で
+decode します。
+
+``` python
+text = client.read(log_name).decode("utf-8")
+```
+
+`tail()` はサーバー側で設定された `encoding` を使って decode され、`str`
+を返します。
+
+## ドキュメント
+
+Sphinx 用文書は `docs/` にあります。
+
+- `docs/index.md`
+- `docs/quickstart.md`
+- `docs/usage.md`
+- `docs/rotation.md`
+- `docs/architecture.md`
+
+## License
+
+`LICENSE` を参照してください。

log_ctrl-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+log_ctrl/__init__.py,sha256=FZk9hm7vBsK8G16pNugputbrrEciYqJc_XRAhTCcojI,46
+log_ctrl/log_ctrl.py,sha256=qGGXOpeGjI4e7NtumBXxUAhNMG6t3eV1YlHY3tjr_UY,6915
+log_ctrl/server_grpc/__init__.py,sha256=TRDLjEBsllUcfWwGzvgmSLkFN8Vm-dp1WlqsrD_8wwQ,1851
+log_ctrl/server_grpc/async_log_grpc_client.py,sha256=3CvcBQoAK8fHjX4GvWSnFP_MvUOjjdcg6f2lkmt3vu4,2330
+log_ctrl/server_grpc/log_grpc_server.py,sha256=AZCEKs9fGDCfBRh97O8_O-o4YgFDwwCOI1aNNk_WIGk,3179
+log_ctrl/server_grpc/sync_log_grpc_client.py,sha256=-bMhAZ-6FZL87w8iORgRbBJtyjjrEKRJQe-zvhDPk_s,1751
+log_ctrl-0.0.1.dist-info/licenses/LICENSE,sha256=_CRGJmUo0He9fWLv1HohpJixSqmuOQZ1rOlDtYNfADo,11357
+log_ctrl-0.0.1.dist-info/METADATA,sha256=lpNrzG8xscD71ZUgtJb3PBX6aLJQZjHMXdoBf4p25wc,18994
+log_ctrl-0.0.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+log_ctrl-0.0.1.dist-info/top_level.txt,sha256=QZMTQjWZNhj5Pg31nbECciKhT-7zvEvwdJTrwZubK5o,9
+log_ctrl-0.0.1.dist-info/RECORD,,

log_ctrl-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

log_ctrl-0.0.1.dist-info/licenses/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.

log_ctrl-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+log_ctrl