codeflowhub 1.2.0__tar.gz → 1.3.0__tar.gz

{codeflowhub-1.2.0 → codeflowhub-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeflowhub
-Version: 1.2.0
+Version: 1.3.0
 Summary: workflow development tools
 Author: creaddiscans
 Author-email: creaddiscans@gmail.com

{codeflowhub-1.2.0 → codeflowhub-1.3.0}/codeflowhub/flow.py

@@ -30,6 +30,7 @@ class FlowDecorator(BaseDecorator):
     export_destination:str  # Export 시 생성 파일 저장 디렉토리
     default_args:dict  # Airflow DAG default_args (owner, retries, retry_delay 등 override)
     schedule:str  # Airflow DAG 스케줄 (cron 문자열 / preset / timedelta / None=수동 트리거)
+    doc_md:str  # Airflow DAG doc_md (UI에 표시될 Markdown 문서)
     start_date:datetime  # Airflow DAG start_date (None이면 export 시점)
     secrets:list  # 모든 task에 공통 주입할 K8s Secret(env) 목록
     on_failure: 'BaseDecorator' = None  # 모든 task의 기본 failure handler
@@ -38,7 +39,7 @@ class FlowDecorator(BaseDecorator):
                  tags=None, annotations=None, service_account_name=None, volumes=None,
                  airflow_sidecar_image=None, airflow_connection_id=None, repo=None, path=None,
                  export_destination='dags', default_args=None, secrets=None, on_failure=None,
-                 schedule=None, start_date=None, schedule_interval=None, **kwargs):
+                 schedule=None, start_date=None, doc_md=None, schedule_interval=None, **kwargs):
         # CLI 속성 먼저 초기화 (init()에서 사용됨)
         self._cli_export = None
         self._cli_job_dir = None
@@ -65,6 +66,7 @@ class FlowDecorator(BaseDecorator):
             self._resolve_schedule_alias(schedule, schedule_interval)
         )
         self.start_date = start_date
+        self.doc_md = self._normalize_doc_md(doc_md)
         # Design Ref: §3.2 — flow-level 공통 Secret(env)
         self.secrets = secrets or []
         self.on_failure = on_failure
@@ -75,6 +77,35 @@ class FlowDecorator(BaseDecorator):
         # super().__init__()는 마지막에 호출 (init()이 실행됨)
         super().__init__(*args, name=name, **kwargs)
 
+    @staticmethod
+    def _normalize_doc_md(doc_md):
+        """doc_md 정규화 (선언 시점에 조기 실패)
+
+        - str: Markdown 본문. 함수 안에서 triple-quote로 쓴 경우의 공통 들여쓰기를 제거
+        - Path: 해당 파일의 내용을 읽어 사용 (README 등 별도 파일 참조용)
+        - None / 빈 문자열: doc_md 미설정
+        """
+        import textwrap
+
+        if doc_md is None:
+            return None
+
+        if isinstance(doc_md, Path):
+            if not doc_md.exists():
+                raise FileNotFoundError(f'doc_md 파일을 찾을 수 없습니다: {doc_md}')
+            text = doc_md.read_text(encoding='utf-8')
+        elif isinstance(doc_md, str):
+            text = doc_md
+        else:
+            raise TypeError(
+                f'doc_md는 str(Markdown 본문), Path(파일 경로), None만 가능합니다. '
+                f'전달된 타입: {type(doc_md).__name__}'
+            )
+
+        # 선행 개행 제거 후 dedent → triple-quote 블록의 들여쓰기가 코드블록으로 렌더되는 것 방지
+        text = textwrap.dedent(text.lstrip('\n')).rstrip()
+        return text or None
+
     @staticmethod
     def _resolve_schedule_alias(schedule, schedule_interval):
         """schedule / schedule_interval(구 이름) 중 하나로 정리

{codeflowhub-1.2.0 → codeflowhub-1.3.0}/codeflowhub/service/airflow_exporter.py

@@ -269,13 +269,24 @@ SETUP_SCRIPT = """{setup_script}"""
             params_str = self._format_dict(self.flow.params, indent=1)
             params_line = f"\n    params={params_str},"
 
-        dag_definition = f'''dag = DAG(
+        # doc_md 설정 — 본문은 DAG_DOC_MD 변수로 분리 (여러 줄 Markdown)
+        doc_md_definition = ""
+        doc_md_line = ""
+        doc_md = getattr(self.flow, 'doc_md', None)
+        if doc_md:
+            doc_md_definition = f'''# DAG documentation (Airflow UI)
+DAG_DOC_MD = {self._render_doc_md(doc_md)}
+
+'''
+            doc_md_line = "\n    doc_md=DAG_DOC_MD,"
+
+        dag_definition = f'''{doc_md_definition}dag = DAG(
     '{self.dag_id}',
     default_args={default_args_str},
     description='{description}',
     schedule={self._render_schedule(schedule)},
     catchup=False,
-    tags={tags_str},{params_line}
+    tags={tags_str},{params_line}{doc_md_line}
 )
 
 '''
@@ -881,6 +892,21 @@ base_volume_mounts = [
                     dependencies.append(f"[{deps_str}] >> {task.name}")
         return dependencies
 
+    def _render_doc_md(self, doc_md):
+        """Markdown 본문 → 생성 DAG의 문자열 리터럴 코드
+
+        줄 단위로 repr()을 적용해 이어붙인다. triple-quote를 쓰면 본문에 포함된
+        따옴표/백슬래시가 문법 오류를 만들 수 있으므로 repr로 완전히 이스케이프하고,
+        줄마다 나누어 생성 DAG에서도 읽을 수 있게 유지한다.
+        """
+        lines = doc_md.split('\n')
+        if len(lines) == 1:
+            return repr(lines[0])
+
+        rendered = [f"    {line + chr(10)!r}" for line in lines[:-1]]
+        rendered.append(f"    {lines[-1]!r}")
+        return '(\n' + '\n'.join(rendered) + '\n)'
+
     def _render_schedule(self, schedule):
         """schedule → DAG 코드 문자열
 

{codeflowhub-1.2.0 → codeflowhub-1.3.0}/codeflowhub.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeflowhub
-Version: 1.2.0
+Version: 1.3.0
 Summary: workflow development tools
 Author: creaddiscans
 Author-email: creaddiscans@gmail.com

{codeflowhub-1.2.0 → codeflowhub-1.3.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='codeflowhub',
-    version='1.2.0',
+    version='1.3.0',
     description='workflow development tools',
     author='creaddiscans',
     author_email='creaddiscans@gmail.com',