chronosx-quant 0.2.0__py3-none-any.whl

chronosx/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0"

chronosx/cli.py

@@ -0,0 +1,32 @@
+import pandas as pd
+import pandas_market_calendars as mcal
+from chronosx.scheduler import SchedulerManager, StaticMinuteScheduler
+
+
+def calendar_preview(calendar_name):
+    with SchedulerManager.use_scheduler(StaticMinuteScheduler(calendar_name)):
+        cal = SchedulerManager.get_scheduler().calendar
+        print(f"---{cal.full_name}---")
+        holidays = cal.holidays()
+        print(f"latest holidays {holidays.kwds['holidays'][-5:]}")
+
+        today = pd.Timestamp.now().date()
+        next_month = today + pd.Timedelta(days=32)
+        holidays_in_range = [
+            h for h in holidays.kwds["holidays"] if h >= today and h < next_month
+        ]
+        print(
+            f"next 32 days [{today}, {next_month}) have holidays: {holidays_in_range}"
+        )
+
+
+def main():
+    print(
+        f"dependency: pandas={pd.__version__}, pandas_market_calendars={mcal.__version__}"
+    )
+    calendar_preview("SSE")
+    calendar_preview("CME Globex Crypto")
+
+
+if __name__ == "__main__":
+    main()

chronosx/mock.py

@@ -0,0 +1,15 @@
+from chronosx.time import ChronoTime
+
+
+class travel:
+    def __init__(self, mock_time):
+        self.mock_time = ChronoTime(mock_time)
+
+    def __enter__(self):
+        ChronoTime._get_stack().append(self.mock_time)
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        stack = ChronoTime._get_stack()
+        if stack:
+            stack.pop()

chronosx/performance.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+import inspect
+import io
+import time
+from fastdigest import TDigest
+from contextlib import ContextDecorator
+from typing import Dict
+
+
+class PerformanceRegistry:
+    """全局存储不同函数的统计数据"""
+
+    _metrics: Dict[str, TDigest] = {}
+
+    @classmethod
+    def update(cls, name: str, value: float):
+        if name not in cls._metrics:
+            cls._metrics[name] = TDigest()
+        cls._metrics[name].update(value)
+
+    @classmethod
+    def get_count(cls, name: str):
+        if name in cls._metrics:
+            return cls._metrics[name].n_values
+        return 0
+
+    @classmethod
+    def get_percentile(cls, name: str, p: float):
+        if name in cls._metrics:
+            return cls._metrics[name].percentile(p * 100)
+        return None
+
+    @classmethod
+    def get_report(cls, name: str):
+        if name in cls._metrics:
+            di = cls._metrics[name]
+            return f"{name}: sum={di.sum()}, count={di.n_values}, mean={di.mean()}, p50={di.percentile(50)}, p90={di.percentile(90)}, p99={di.percentile(99)}, p999={di.percentile(99.9)}, p9999={di.percentile(99.99)}"
+        return f"{name}: not found"
+
+    @classmethod
+    def full_report(cls):
+        b = io.StringIO()
+        for name in cls._metrics.keys():
+            b.write(f"{cls.get_report(name)}\n")
+        return b.getvalue()
+
+    @classmethod
+    def clear(cls):
+        cls._metrics.clear()
+
+
+class performance(ContextDecorator):
+    def __init__(self, name: str = None):
+        self.name = name
+        self.start_wall = 0.0
+
+    def __call__(self, func):
+        # 当作为装饰器使用时，如果没传 name，自动获取函数名
+        if self.name is None:
+            self.name = func.__qualname__
+        return super().__call__(func)
+
+    def __enter__(self):
+        # 如果是 with 块且没传 name，尝试获取文件名和行号
+        if self.name is None:
+            caller_frame = inspect.currentframe().f_back
+            file_name = caller_frame.f_code.co_filename.split("/")[-1]
+            line_no = caller_frame.f_lineno
+            self.name = f"{file_name}:{line_no}"
+
+        self.start_wall = time.perf_counter()
+        return self
+
+    def __exit__(self, *args):
+        elapsed_ms = (time.perf_counter() - self.start_wall) * 1000
+        PerformanceRegistry.update(self.name, elapsed_ms)

chronosx/scheduler.py

@@ -0,0 +1,233 @@
+from contextlib import contextmanager
+from datetime import tzinfo
+from functools import wraps
+import os
+import threading
+
+import pandas_market_calendars as mcal
+import pandas as pd
+
+"""Scheduler is a wrapper of Calendar and schedules, """
+
+
+def require_1min_step(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        step = kwargs.get("step")
+        if step is not None and step != "1min":
+            raise ValueError(
+                f"Performance Lock: '{func.__name__}' only supports step='1min'."
+            )
+
+        return func(*args, **kwargs)
+
+    return wrapper
+
+
+class SchedulerManager:
+    _storage = threading.local()
+
+    @staticmethod
+    def get_scheduler():
+        if not hasattr(SchedulerManager._storage, "schedule"):
+            # SSE: China Exchange (Shanghai, Shenzhen, CFE) are all in the same timezone, so we can use the same calendar for them.
+            # CME Globex Crypto
+            # other calendars haven't been checked
+            SchedulerManager._storage.schedule = StaticMinuteScheduler(
+                os.getenv("CALENDAR_NAME", "SSE")
+            )
+        return SchedulerManager._storage.schedule
+
+    @staticmethod
+    def set_scheduler(schedule):
+        SchedulerManager._storage.schedule = schedule
+
+    @staticmethod
+    @contextmanager
+    def use_scheduler(temp_schedule):
+        """
+        临时切换 Schedule，退出 with 块后自动恢复。
+        用法:
+        with SchedulerManager.use_schedule(MockSchedule()):
+            # 执行测试逻辑
+        """
+        # 1. 记录旧状态
+        has_old = hasattr(SchedulerManager._storage, "schedule")
+        old_schedule = getattr(SchedulerManager._storage, "schedule", None)
+
+        # 2. 设置新状态
+        SchedulerManager.set_scheduler(temp_schedule)
+
+        try:
+            yield
+        finally:
+            # 3. 恢复旧状态
+            if has_old:
+                SchedulerManager.set_scheduler(old_schedule)
+            else:
+                # 如果原本没有 schedule，则清理掉，保持 threading.local 干净
+                if hasattr(SchedulerManager._storage, "schedule"):
+                    del SchedulerManager._storage.schedule
+
+
+class SchedulerTemplate:
+    def shift(self, time: pd.Timestamp, delta: int, step: str) -> pd.Timestamp: ...
+    def trading_times(
+        self, start: pd.Timestamp, end: pd.Timestamp, step: str
+    ) -> pd.Series: ...
+    def previous_trading_time(
+        self, time: pd.Timestamp, step: str, inclusive=True
+    ) -> pd.Timestamp: ...
+    def next_trading_time(
+        self, time: pd.Timestamp, step: str, inclusive=True
+    ) -> pd.Timestamp: ...
+
+    def is_trading(self, time: pd.Timestamp) -> bool: ...
+    def is_trading_day(self, time: pd.Timestamp) -> bool:
+        """Check if the time is a trading day, no matter if it's a trading time."""
+        ...
+
+    def to_session_start(self, time: pd.Timestamp) -> pd.Timestamp: ...
+    def to_session_end(self, time: pd.Timestamp) -> pd.Timestamp: ...
+
+    @property
+    def tz(self) -> tzinfo: ...
+
+
+class StaticMinuteScheduler(SchedulerTemplate):
+    """
+    Load last 3 years and next 3 year schedule, let it crash if time is not in the schedule
+
+    For performance, only support 1 minute step, prepare all timeline when init, no more updates
+    """
+
+    def __init__(self, calendar_name: str):
+        self.calendar = mcal.get_calendar(calendar_name)
+        self.schedule = self.calendar.schedule(
+            pd.Timestamp.now() - pd.Timedelta(days=365 * 3),
+            pd.Timestamp.now() + pd.Timedelta(days=365 * 3),
+            tz=self.calendar.tz,
+        )
+        self.session_intervals = pd.IntervalIndex.from_arrays(
+            self.schedule["market_open"],
+            self.schedule["market_close"],
+            closed="left",
+        )
+        if "break_start" not in self.schedule.columns:
+            self.intervals = self.session_intervals
+        else:
+            # SSE 1 break per trading day, haven't consider about multi breaks
+            starts_1 = self.schedule["market_open"]
+            ends_1 = self.schedule["break_start"]
+
+            starts_2 = self.schedule["break_end"]
+            ends_2 = self.schedule["market_close"]
+
+            # 纵向拼接 (Flatten)
+            all_starts = pd.concat([starts_1, starts_2]).dropna().sort_values()
+            all_ends = pd.concat([ends_1, ends_2]).dropna().sort_values()
+
+            # 一次性构造，确保顺序严格递增且无重复
+            self.intervals = pd.IntervalIndex.from_arrays(
+                all_starts, all_ends, closed="left"
+            )
+
+        # date_range time is the end time, but we want the start time, so we need to shift back by one step
+        self.trading_minutes = mcal.date_range(
+            self.schedule, frequency="1min"
+        ) - pd.Timedelta("1min")
+
+    @property
+    def tz(self):
+        return self.calendar.tz
+
+    def __repr__(self):
+        return f"StaticMinuteScheduler({self.calendar.name}, end={self.schedule.index[-1]})"
+
+    @require_1min_step
+    def shift(self, time: pd.Timestamp, delta: int, *, step: str) -> pd.Timestamp:
+        """
+        Shift the time by delta in trading time, i.e. jump to the next trading time if the result is not a trading time.
+
+        Time should be a valid trading time.
+        """
+        # raise an error if time is not a trading time
+        time_idx = self.trading_minutes.get_loc(time)
+        # raise an error if out of range
+        return self.trading_minutes[time_idx + delta]
+
+    @require_1min_step
+    def trading_times(
+        self, start: pd.Timestamp, end: pd.Timestamp, *, step: str
+    ) -> pd.Series:
+        # [start, end)
+        left_idx = self.trading_minutes.searchsorted(start, side="left")
+        right_idx = self.trading_minutes.searchsorted(end, side="left")
+        return self.trading_minutes[left_idx:right_idx].to_series()
+
+    @require_1min_step
+    def previous_trading_time(
+        self, time: pd.Timestamp, *, step: str, inclusive: bool
+    ) -> pd.Timestamp:
+        # inclusive, search right means > time, -1 must be <= time
+        # exclusive, search left means >= time, -1 must be < time
+        # TODO: binary search is quick, but time may out of range
+        idx = (
+            self.trading_minutes.searchsorted(
+                time, side="right" if inclusive else "left"
+            )
+            - 1
+        )
+        return self.trading_minutes[idx] if idx >= 0 else None
+
+    @require_1min_step
+    def next_trading_time(
+        self, time: pd.Timestamp, *, step: str, inclusive: bool
+    ) -> pd.Timestamp:
+        # inclusive, search left means >= time
+        # exclusive, search right means > time
+        idx = self.trading_minutes.searchsorted(
+            time, side="left" if inclusive else "right"
+        )
+        return self.trading_minutes[idx] if idx < len(self.trading_minutes) else None
+
+    def is_trading(self, time: pd.Timestamp) -> bool:
+        """Check if the time is a trading time."""
+        # be careful to exclude break times
+        idx = self.intervals.get_indexer([time])
+        return idx[0] != -1
+
+    def is_trading_day(self, time: pd.Timestamp) -> bool:
+        """Check if the date is in trading, no matter if it's a trading time."""
+        # trading day may start from previous day, use interval to check
+        day_start = time.normalize()
+        day_end = day_start + pd.Timedelta(days=1) - pd.Timedelta(nanoseconds=1)
+        target_interval = pd.Interval(day_start, day_end, closed="left")
+
+        # 检查 IntervalIndex 中是否有任何区间与这一天重叠
+        # overlaps 返回一个布尔数组，.any() 判断是否存在至少一个 True
+        # use session intervals, cuz we don't care breaks
+        return self.session_intervals.overlaps(target_interval).any()
+
+    def _fetch_interval(self, time: pd.Timestamp):
+        # find time belongs to which trading day in schedule
+        # check target_time, contains will return a mask
+        is_inside = self.session_intervals.contains(time)
+
+        if not is_inside.any():
+            raise ValueError(f"Time {time} is not in trading interval")
+        if is_inside.sum() != 1:
+            raise ValueError(
+                f"Time {time} is in multiple trading days {self.intervals[is_inside]}"
+            )
+
+        return self.schedule.loc[is_inside].iloc[0]
+
+    def to_session_end(self, time: pd.Timestamp) -> pd.Timestamp:
+        """use calendar cuz we may meet early close time before holidays"""
+        trading_day = self._fetch_interval(time)
+        return trading_day["market_close"]
+
+    def to_session_start(self, time: pd.Timestamp) -> pd.Timestamp:
+        trading_day = self._fetch_interval(time)
+        return trading_day["market_open"]

chronosx/time.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+from datetime import datetime
+import threading
+from typing import Union
+import pandas as pd
+
+from chronosx.scheduler import SchedulerManager
+
+
+class ChronoTime(pd.Timestamp):
+    # mock now() thread-safely
+    _local = threading.local()
+
+    @staticmethod
+    def _get_stack():
+        if not hasattr(ChronoTime._local, "stack"):
+            ChronoTime._local.stack = []
+        return ChronoTime._local.stack
+
+    @staticmethod
+    def now():
+        stack = ChronoTime._get_stack()
+        if stack:
+            # if in mock, return mock time
+            return stack[-1]
+        tz = SchedulerManager.get_scheduler().tz
+        return ChronoTime(pd.Timestamp.now(tz))
+
+    def __new__(cls, ts: Union[datetime, str, "ChronoTime", int, float]):
+        temp_ts = pd.Timestamp(ts)
+        default_tz = SchedulerManager.get_scheduler().tz
+        if temp_ts.tz is None:
+            temp_ts = temp_ts.tz_localize(default_tz)
+        elif temp_ts.tz != default_tz:
+            # convert to named tz, to avoid compare static tz time with named tz time of scheduler
+            temp_ts = temp_ts.tz_convert(default_tz)
+        instance = super().__new__(cls, temp_ts)
+        instance.__class__ = cls
+        return instance
+
+    def shift(self, delta: int, step: str = "1min") -> ChronoTime:
+        return ChronoTime(
+            SchedulerManager.get_scheduler().shift(time=self, delta=delta, step=step)
+        )
+
+    def trading_times(
+        self, end: Union[datetime, "ChronoTime", pd.Timestamp], step: str = "1min"
+    ) -> pd.Series:
+        """
+        [self, end)
+        """
+        return SchedulerManager.get_scheduler().trading_times(
+            start=self, end=ChronoTime(end), step=step
+        )
+
+    def previous_trading_time(self, step: str = "1min", inclusive=True) -> ChronoTime:
+        return ChronoTime(
+            SchedulerManager.get_scheduler().previous_trading_time(
+                time=self, step=step, inclusive=inclusive
+            )
+        )
+
+    def next_trading_time(self, step: str = "1min", inclusive=True) -> ChronoTime:
+        return ChronoTime(
+            SchedulerManager.get_scheduler().next_trading_time(
+                time=self, step=step, inclusive=inclusive
+            )
+        )
+
+    def is_trading(self) -> bool:
+        return SchedulerManager.get_scheduler().is_trading(self)
+
+    def is_trading_day(self) -> bool:
+        return SchedulerManager.get_scheduler().is_trading_day(self)
+
+    def to_session_start(self) -> ChronoTime:
+        return ChronoTime(SchedulerManager.get_scheduler().to_session_start(self))
+
+    def to_session_end(self) -> ChronoTime:
+        return ChronoTime(SchedulerManager.get_scheduler().to_session_end(self))

chronosx_quant-0.2.0.dist-info/METADATA

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: chronosx-quant
+Version: 0.2.0
+Summary: A Python library for trading calendar management, execution profiling, and temporal backtesting (Time Travel).
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: fastdigest
+Requires-Dist: pandas
+Requires-Dist: pandas-market-calendars==5.3.1
+Description-Content-Type: text/markdown
+
+# Chronosx
+
+A Python library for trading calendar management, execution profiling, and temporal backtesting (Time Travel).
+
+## Installation
+
+```bash
+uv build
+pip install dist/chronosx-0.2.0-py3-none-any.whl
+# haven't upload to pypi
+# pip install chronosx
+```
+
+## Usage
+
+```python
+from chronosx.time import ChronoTime
+# use CALENDAR_NAME to select default calendar, e.g. SSE
+time = ChronoTime.now()
+time = ChronoTime("2026-03-08 11:29:00+08:00")
+
+# time about trading, only support 1min step now
+time.is_trading()
+# move 2 steps forward(2min), auto skip breaks and weekends
+# e.g. 2026-03-08 11:29:00+08:00" -> "2026-03-08 13:01:00+08:00"
+time.shift(2)
+# select valid trading times from self to end
+# return series of 2 items, 11:29:00 and 13:00:00
+time.trading_times(end=pd.Timestamp("2026-03-08 13:01:00+08:00"))
+# move to the beginning of trading session which the time belongs to
+# e.g. SSE "2026-03-08 11:29:00+08:00" belongs to session '2026-03-08', so the session start is '2026-03-08 09:30:00+08:00'
+# e.g. CME session '2026-03-08' starts from '2026-03-07 17:00:00-06:00', so the session start is '2026-03-07 17:00:00-06:00', not '2026-03-08 00:00:00+00:00'
+time.to_session_start()
+
+# performance profiling
+from chronosx.performance import performance, PerformanceRegistry
+@performance("slug_name")
+def f1():
+    ...
+f1()
+# get report of this function
+print(PerformanceRegistry.get_report("slug_name"))
+# get report of all functions
+print(PerformanceRegistry.get_report())
+# if you want to reset
+PerformanceRegistry.clear()
+
+# time travel
+from chronosx.mock import travel
+with travel("2026-03-08 11:29:00+08:00"):
+    # only effect ChronoTime, datetime or pd.Timestamp still work
+    # thread-local mock, thread-safe
+    ChronoTime.now()
+```
+
+### Add calendar
+
+Chronosx based on pandas_market_calendars, so it can use all calendars in the project, and support to add custom calendars.
+
+### Add scheduler
+
+I use static minute scheduler for speed, don't support multi step in the same time, and don't support extend schedule time range. It's ok to add new scheduler to support multi step or dynamic time range.

chronosx_quant-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+chronosx/__init__.py,sha256=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
+chronosx/cli.py,sha256=F0l3-eTgMy5JZIviHCXZEdVbDjK7bCxOaD8vEDKrYc4,1005
+chronosx/mock.py,sha256=5YlLX0IXUDJew41__MKK4rz314cKBQC26jH_e4F6kaU,370
+chronosx/performance.py,sha256=ZRD2TkDBP8-3v4XElFYwrDKZ3iniQ6_XChoIZFMjn5E,2367
+chronosx/scheduler.py,sha256=pxRfQi6-FlSLr-KvDVSH1hWUgTDcjHP_nv0qL04YeHc,8755
+chronosx/time.py,sha256=gxYDn08OcX3BfuapK5G87GUin4AdlQ7iPaXHtkmQryU,2731
+chronosx_quant-0.2.0.dist-info/METADATA,sha256=-VnptvYuI3xf_5kIi9Mc8MGakh5zGG1877CYZPdWhMU,2475
+chronosx_quant-0.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+chronosx_quant-0.2.0.dist-info/entry_points.txt,sha256=q6-qMD1n05ico3m0OHZllrazyYCBe1-yUu3MjcU9Nvo,42
+chronosx_quant-0.2.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+chronosx_quant-0.2.0.dist-info/RECORD,,

chronosx_quant-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

chronosx_quant-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cli = chronosx.cli:main

chronosx_quant-0.2.0.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 [yyyy] [name of copyright owner]
+
+   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.