xflow.framework 0.1.0__py3-none-any.whl

xflow/framework/statics/initdir/pipelines/template.py

@@ -0,0 +1,32 @@
+from xflow.framework.pipeline import Pipeline
+
+
+class template(Pipeline):
+    """
+    pipeline 模版。
+    """
+    class Options(Pipeline.Options):
+        """
+        流水线参数表，根据需要自行定义。
+        """
+        pass
+
+    def setup(self) -> None:
+        """
+        前置步骤。
+        """
+        self.options: __class__.Options  # 保留用于自动提示
+        super().setup()
+
+    def stage1(self) -> None:
+        """
+        阶段 1。
+        每个 Pipeline 至少 1 个阶段，然后根据需要继续添加，命名为 stage2, stage3, ...。
+        """
+        pass
+
+    def teardown(self) -> None:
+        """
+        后置步骤。
+        """
+        super().teardown()

xflow/framework/statics/initdir/requirements.txt

@@ -0,0 +1 @@
+xflow.framework; python_version >= '3.10'

xflow/framework/utils.py

@@ -0,0 +1,59 @@
+# Copyright (c) 2025-2026, zhaowcheng <zhaowcheng@163.com>
+
+"""
+实用函数。
+"""
+
+import re
+import string
+import functools
+
+from typing import Callable, Any, TypeVar
+
+
+T = TypeVar('T')
+
+
+def remove_ansi_escape_chars(s: str) -> str:
+    """
+    移除 `s` 中的 ANSI 转义字符。
+
+    >>> remove_ansi_escape_chars('\x1b[31mhello\x1b[0m')
+    'hello'
+    """
+    escapes = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
+    return escapes.sub('', s)
+
+
+def remove_unprintable_chars(s: str) -> str:
+    """
+    移除 `s` 中的不可打印字符。
+
+    >>> remove_unprintable_chars('hello\xe9')
+    'hello'
+    """
+    return ''.join(c for c in s if c in string.printable)
+
+def copy_signature(f: T) -> Callable[[Any], T]:
+    """
+    拷贝函数签名。
+
+    示例：
+    class Child(Parent):
+        @copy_signature(Parent.__init__)
+        def __init(self, *args, **kwargs):
+            ...
+    """
+    def decorator(func):
+        @functools.wraps(f)
+        def wrapper(*args, **kwargs):
+            return func(*args, **kwargs)
+        return wrapper
+    return decorator
+
+
+def isclass(obj: Any) -> bool:
+    """
+    判断一个对象是否为 class。
+    """
+    return isinstance(obj, type)

xflow/framework/version.py

@@ -0,0 +1,4 @@
+# Copyright (c) 2025-2026, zhaowcheng <zhaowcheng@163.com>
+
+
+__version__ = '0.1.0'

xflow_framework-0.1.0.dist-info/METADATA

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: xflow.framework
+Version: 0.1.0
+Summary: 可以用 Python 写 Pipeline 的 CICD 框架。
+Home-page: https://github.com/zhaowcheng/xflow.framework
+Author: zhaowcheng
+Author-email: zhaowcheng@163.com
+Project-URL: Homepage, https://github.com/zhaowcheng/xflow.framework
+Project-URL: Issues, https://github.com/zhaowcheng/xflow.framework/issues
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+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
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ruamel.yaml; python_version >= "3.10"
+Requires-Dist: paramiko; python_version >= "3.10"
+Requires-Dist: decorator; python_version >= "3.10"
+Requires-Dist: filelock; python_version >= "3.10"
+Requires-Dist: docker; python_version >= "3.10"
+Requires-Dist: typed-settings[click,option-groups,pydantic]; python_version >= "3.10"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# xflow.framework
+
+可以用 Python 写 Pipeline 的 CICD 框架。

xflow_framework-0.1.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+xflow/framework/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xflow/framework/common.py,sha256=RBBGbrt5EPor7vqCzAHpiPRq-sVmUu13j8jS4BK-RE8,248
+xflow/framework/container.py,sha256=PEMcive1lmKvvK5T1vEZpHgmkYQYgFIntfOfFJpIDe0,9917
+xflow/framework/env.py,sha256=hRH0LLsgWin7z2M8-1Q2pLrmJXEmssLx62MRH3IMhbc,2570
+xflow/framework/errors.py,sha256=xRP_tQHppTNreIgWH9KRfAENzKzpzCetNRFdAwgX5us,414
+xflow/framework/main.py,sha256=EIbPQ5cYKSn8BDP7OS65c9CgsOChUmq6giR3fbYzG3Y,3128
+xflow/framework/node.py,sha256=21iQ85x7yytmnHPEOGr14zKk_IQc3ixqp5UjCTcT2uU,11975
+xflow/framework/pipeline.py,sha256=sa82beYkEg8GdbptVa26hs6ZkqoPFdsl7a4LvOZdp7U,5404
+xflow/framework/ssh.py,sha256=ECcK5JqAlKNGX68wKn4BD6K4z0XkCC6-5Kg8s1acHzU,11873
+xflow/framework/utils.py,sha256=oudWRFgArvTdrSC8VHayLeI5x-k5B5TZz_MmpRXCQUc,1214
+xflow/framework/version.py,sha256=e17lod75nE1Pm7KotA4DXcuSLFxpJ4LW5AqtTQw5Ock,83
+xflow/framework/statics/initdir/.gitignore,sha256=drJ9PRWUOnX_mD-HEXGb__cULv6W982sW0AXcaOzJN4,4744
+xflow/framework/statics/initdir/README.md,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xflow/framework/statics/initdir/env.yml,sha256=sXVI3zq2AS_746MR3NGTQpVtmAUcKo7w5f4YH2et8Qo,1636
+xflow/framework/statics/initdir/requirements.txt,sha256=lj15yzHdRYb7baWFkomr0upOJymrWeEc03jc9_osnCs,42
+xflow/framework/statics/initdir/pipelines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xflow/framework/statics/initdir/pipelines/example.py,sha256=kJ1RIqaEC1od9Piz3F9PO_0pooNSkZPLAB1ZrcYIxis,1883
+xflow/framework/statics/initdir/pipelines/template.py,sha256=595PStCieqTZWj0sShU0PsvCN6aijqaSukU5TjBw0b4,721
+xflow/framework/statics/initdir/scripts/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xflow/framework/statics/initdir/workdir/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xflow_framework-0.1.0.dist-info/licenses/LICENSE,sha256=xjp2TAWd0AUuZsDINij5H-63Fwlj_gY5yEv0SQvuxGs,1299
+xflow_framework-0.1.0.dist-info/METADATA,sha256=dmH4rvzKHYm8JSsP3ffbZxYLvzl-UbxMpI4s-aOwinI,1600
+xflow_framework-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+xflow_framework-0.1.0.dist-info/entry_points.txt,sha256=RAKUT9t3X0eLi9bSZRAiiksLiJrtk7jnIWgqGnua06Y,52
+xflow_framework-0.1.0.dist-info/top_level.txt,sha256=KpSEzlVEQPRF8tqL3Szng-Fmb9CnOqIcGfPoiHRjZ8c,6
+xflow_framework-0.1.0.dist-info/RECORD,,

xflow_framework-0.1.0.dist-info/WHEEL

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

xflow_framework-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+xflow = xflow.framework.main:main

xflow_framework-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2025, zhaowcheng
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

xflow_framework-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+xflow