tslite-og 2.1.0__tar.gz

tslite_og-2.1.0/CHANGELOG.md

@@ -0,0 +1,298 @@
+# Changelog
+
+## 2.1.0 — Unreleased
+
+### Added
+
+- `interpolate(interval, anchor=None)` accepts an optional datetime alignment
+  anchor. Only aligned regular time steps within the observed range are emitted;
+  anchors before or after the data work without extrapolation.
+
+- `getFiscalYear(start_date)` selects available observations from an arbitrary
+  start date through (but excluding) its next calendar-year anniversary. Accepts
+  date strings, dates, and datetimes; partial years are allowed. `getWY(year)`
+  delegates to it with October 1 of the previous year.
+
+- Temporary `scripts/migrate_sqlite_milliseconds.py OLD.db NEW.db TABLE ...`
+  utility copies a database and converts explicitly selected integer timestamp
+  keys from milliseconds to microseconds. It preserves the original, other
+  columns, and indexes; run once and verify before switching files.
+
+- PyPI packaging prepared as `tslite-og` (branding `tslite-OG`), retaining
+  `import tslite` and the single-module layout. Python 3.11+ support, uv tooling,
+  optional NumPy extra, runnable README examples, and local multi-version
+  test/build verification without a hosted CI dependency.
+  Release artifacts are local only; publication awaits correctness review.
+
+- `timeseries.createRegular(start, end, interval, value=0)` creates a new
+  constant-valued series on a regular time grid. Start is included; end is
+  included when on-grid. Intervals must be positive.
+- Explicit comparisons: `same_data()` ignores timestamps with configurable
+  decimal precision; `is_close()` accepts timestamp, absolute-value, and
+  relative-value tolerances.
+- Pytest regression/characterization tests and a maintained Markdown manual with
+  public-method coverage and executable examples.
+
+### Changed
+
+- Documentation now consists of the README introduction and a rewritten
+  `doc/tslite.md` manual with public-method explanations and examples. Removed
+  MkDocs configuration, generated-reference guides, and documentation-only
+  dependencies. Manual examples and method coverage run in pytest; the source
+  distribution includes the manual. No documentation server is required.
+
+- `diff(other, precision=6)` exposes its existing fixed-decimal comparison
+  precision, retaining incoming-only change semantics and unrounded output values.
+  None comparisons are safe; matching None/NaN and same-sign infinities are
+  unchanged. Decimal formatting rounds rather than truncates, as before.
+
+- `merge()` prefers finite observations over missing/nonfinite values at matching
+  timestamps, regardless of side. Incoming/right values win when both are usable
+  or both unusable. Unmatched missing records are retained. A linear two-pointer
+  traversal returns independent records; insert replacement rules are unchanged.
+
+- Construction and safe insertion preserve explicit None-valued records rather
+  than dropping their timestamps. JSON null imports now retain those records.
+  Duplicate timestamps still use the last supplied value, including None.
+
+- **Compatibility change:** `average()` and standalone `accumulate()` label
+  half-open interval buckets at their beginning, not their end. Values are
+  unchanged for finite input, but timestamps shift back one interval. Final
+  partial buckets remain included; empty buckets remain omitted. `accumulateWY()`
+  already uses beginning labels and is unchanged by this label change.
+- `average()` excludes missing/nonfinite values, yields NaN for all-invalid
+  observed buckets, and records skipped-data warnings in source status. It groups
+  observed buckets directly rather than walking through long empty gaps.
+
+- Totals skip missing/nonfinite increments and report skipped counts plus an
+  incomplete-total warning in the source series' status. Running and water-year
+  totals carry known subtotals; independent all-invalid accumulation buckets
+  yield NaN. Water-year resets remain intact; invalid seeds use zero for new
+  extension only, with a warning and existing records preserved. Successful
+  operations without skips reset status to OK.
+- `accumulate()` excludes observations before an explicit bucket start and
+  groups observed buckets directly, avoiding iteration through long empty gaps.
+
+- Pointwise add/subtract/multiply/divide retain usable results when another
+  matched pair is missing, nonfinite, zero-dividing, or overflowing. Bad pairs
+  produce NaN at their timestamps. Series alignment remains exact-match-only;
+  a matched None is preserved as NaN rather than mistaken for an absent record.
+
+- Global mean/variance/stddev and moving averages/stddev exclude missing and
+  nonfinite values, using the usable observation count. All-invalid nonempty
+  windows produce NaN at their normal labels; empty global statistics still
+  return None. Centered moving averages recover after invalid values leave a
+  window instead of retaining a poisoned running sum.
+
+- `toJSON(timefmt=None, decimals=None, strict=False)` now uses valid JSON encoding,
+  ISO timestamps with subseconds, and full float precision by default. Existing
+  `timefmt` overrides remain supported; `decimals` optionally rounds values.
+  Missing/nonfinite values export as null, retaining timestamps for plotting
+  gaps. `strict=True` rejects NaN/infinity instead. `toJS()` remains a variable-
+  declaration wrapper with the same options. The importer preserves null-valued
+  observations as None; NaN/infinity distinctions are lost when exported as null.
+
+- SQLite timestamps now use **integer epoch microseconds**, preserving all
+  datetime fractional digits without float epoch multiplication. Existing
+  millisecond tables must be explicitly converted before loading or writing;
+  no unit guessing or automatic migration is performed. Older library versions
+  must not read the new units. Storage is now machine-timezone independent.
+  SQLite and binary methods accept `tz=None` (naive clock readings) or an explicit
+  IANA zone name (convert between local clock readings and UTC stored instants).
+  Returned timestamps remain naive. Load old local-encoded files with the original
+  writer's zone. Ambiguous/nonexistent local write times are rejected.
+
+- Ordinary SQLite saves use change-aware `ON CONFLICT(timestamp)` upserts:
+  insert new timestamps, update only different values, and leave identical rows
+  untouched. Updates preserve other columns and referencing rows rather than
+  deleting/reinserting records. Explicit table replacement remains available.
+
+- SQLite saves use a savepoint instead of committing unrelated caller work.
+  With an existing transaction, the caller now owns commit/rollback; otherwise
+  successful saves commit as before. Success resets the series status to OK.
+
+- Forward/backward averages now average available observations in partial edge
+  windows by default. Pass `require_full_window=True` to retain the prior
+  omission of incomplete windows. Forward results keep the requested window-end
+  label, even beyond the last observation; backward labels are unchanged.
+
+- `TD()` and `parseTimedelta()` accept `positive=True` to require forward steps.
+  General parsing retains signed/zero durations, fractions, whitespace, and
+  365-day years. Malformed/out-of-range strings now raise ValueError rather
+  than returning a partial duration; unsupported types raise TypeError.
+- Resampling, aggregation, moving windows, snap, fill operations, and regular
+  creation reject nonpositive intervals before processing even empty input.
+  Snap buffers may be zero but not negative.
+
+- Series equality now requires exact timestamp and numerical-value matches.
+  Use `same_data(precision=...)` for the old value-only comparison or `is_close()`
+  for explicit tolerances. The precision argument to `__eq__` is removed.
+
+- Out-of-range integer indexing now raises IndexError instead of returning
+  `[None, None]`. Negative indices and list slices follow Python list semantics.
+  Explicit iteration terminates normally; records remain mutable references.
+
+### Removed
+
+- Deprecated `cullValues()`. Use `cullEqual(value)`; convert numeric strings
+  explicitly with `float(value)` before passing them.
+
+- Unused `runningTotal(override_startTime=...)` argument. Use subslicing to
+  restrict the summed range. `accumulate()` retains its functional bucket-start
+  override for explicit interval alignment.
+
+- Ignored `quality` argument to `insert()`. Variance and standard deviation now
+  return `[timestamp, value]` without the obsolete quality placeholder.
+
+- Compatibility aliases `timeSeries`, `rdb.rate2()`, and `rdb.rateTS2()`.
+  Use `timeseries`, `rdb.reverseRate()`, and `rdb.reverseRateTS()` respectively.
+  `firstdifference()` remains as the statistical name for `simpledelta()`;
+  `parseTimedelta()` and `TD()` are also retained.
+
+- Old-format readers `loadSQLITE3v1()`, `loadBinaryV1()`, and `fromBinaryV1()`.
+  Convert old stores with an earlier library version before upgrading.
+  The binary double/double layout is unchanged. Current SQLite now uses
+  microseconds as described above; the temporary utility migrates milliseconds.
+- Replaced `test/testv1.dat` with converted `test/source.dat`, verifying all
+  45,661 epoch timestamps and values exactly before removing the old reader.
+
+### Fixed
+
+- Binary writes encode None values as NaN in the unchanged double/double layout.
+  Reads retain complete records from truncated input and report incomplete
+  trailing bytes in status instead of silently ignoring short files or raising
+  after partial loading. SQLite NaN-to-NULL behavior is documented and tested;
+  TSV remains unchanged as human-readable reporting output.
+
+- `percent()` shares the pointwise arithmetic implementation: exact timestamp
+  matches are retained as NaN for missing/nonfinite values, zero denominators,
+  or overflow, instead of dropping zero-denominator timestamps or discarding
+  otherwise valid results. Unmatched timestamps remain omitted.
+
+- `averageWY()` matches complete calendar positions including seconds and
+  microseconds, retaining latest-water-year timestamps and averaging available
+  matches including that year. Leap days match only leap days. Invalid matching
+  values are skipped with warnings; all-invalid positions yield NaN. Broad
+  exception suppression and iteration over absent years are removed.
+
+- Global min/max skip missing/nonfinite observations with source-status warnings,
+  retaining the actual extremum timestamp and earliest ties. Empty or all-invalid
+  input returns None rather than order-dependent NaN or comparison errors.
+
+- `maxmin()` no longer fills empty buckets from future observations. Interval
+  extrema now use beginning-labeled half-open buckets, matching means and sums.
+  Missing/nonfinite observations are skipped with a source-status warning;
+  all-invalid observed buckets yield NaN and empty buckets are omitted.
+
+- Regression fits use relative timestamps and centered, normalized sums instead
+  of subtracting large epoch products. `linreg()` retains its epoch-intercept
+  return contract; `trendline()` evaluates the stable relative fit directly.
+  Missing/nonfinite values are excluded from fitting, with predictions retained
+  at every original timestamp. Singleton/constant fits are horizontal with zero
+  correlation by convention; no usable values yield a zero fit.
+
+- `fillMissing()` now merges existing observations with missing regular steps
+  within inclusive bounds. Off-step observations are preserved, outside records
+  excluded, exact matches never overwritten, and singleton inputs retained.
+  Empty input with explicit bounds generates fills including an aligned endpoint.
+  Records remain independent; broad inner exception suppression is removed.
+
+- `filldown()` omits unsupported leading steps rather than inventing zero values,
+  preserving explicit start alignment. Trailing carry-forward no longer emits
+  a step beyond an unaligned requested end time. Offset boundaries compare full
+  timestamps and stop when already aligned, rather than extending another day.
+
+- `interpolate()` now uses regular time steps anchored at the first observation,
+  including valid interior steps for non-divisible gaps and the final timestamp
+  when aligned. Exact timestamp matches copy source values without recalculation.
+  Singleton/short-span inputs return the first observation; no extrapolation is
+  performed. Previously stepping restarted per segment and dropped endpoints.
+
+- `subSlice()` uses bisect boundaries and direct independent record copies,
+  retaining inclusive endpoints and empty results for reversed/nonoverlapping
+  ranges without the old nearby-index scan.
+
+- `findClosestIndex()` now returns the genuinely nearest observation rather than
+  the final binary-search midpoint. Equal-distance ties choose the earlier
+  observation; out-of-range requests choose the nearest endpoint and empty
+  series return -1.
+
+- `snap()` uses binary search and full timedelta distances, retaining days and
+  microseconds. Each grid point independently selects its nearest observation;
+  ties choose the earlier one. Oversized buffers are honored with a warning in
+  the source series' status rather than silently clamped. Observations may be
+  reused across grid points; no averaging or interpolation occurs.
+- `insert()` uses standard-library bisect for sorted insertion and exact-match
+  replacement, retaining the fast append path.
+
+- `getWY()` includes the entire final September 30, not just midnight.
+- `accumulateWY()` preserves existing cumulative records and appends totals for
+  beginning-labeled, half-open interval buckets after the last completed period.
+  Empty bases start from zero, counting the first increment once. Resets follow
+  bucket-start water years, including across gaps and multi-day intervals;
+  offsets retain whole days. Buckets crossing a reset are not split. Neither
+  input is mutated or aliased; empty increments return an independent copy.
+
+- Legacy binary writes include fractional epoch seconds instead of discarding
+  subseconds. The native double/double layout and whole-second bytes are unchanged.
+  Double precision still limits timestamp resolution far from the epoch.
+
+- SQLite writes quote literal table names, bulk-insert observations, and roll
+  back partial writes or table replacement on failure. Interrupts also clean
+  up before propagating. Existing timestamp/storage and upsert rules remain.
+
+- Moving standard deviation inserts normal two-field observations and skips
+  empty windows instead of appending None. Inclusive windows and last-observation
+  labels remain; duplicate output labels use normal last-insert-wins semantics.
+
+- SQLite date-range loading converts bounds to the correct epoch units instead
+  of repeating a timetuple. The current loader supports either or both
+  inclusive bounds, preserves fractional seconds in bounds, parameterizes values,
+  quote literal table names, and explicitly order rows by timestamp. Legacy
+  loader-owned status errors are unchanged; timezone conversion is explicit.
+
+- Global min/max include all observations and handle singleton/empty input.
+  Results are independent records labeled with the actual observation's
+  timestamp; ties select the earliest observation.
+- Moving standard deviation now uses interval validation instead of comparing
+  the uncalled `total_seconds` method to zero.
+
+- Global average includes every observation and handles singleton input;
+  variance and standard deviation consequently use the complete mean.
+- Centered moving averages include preceding as well as following observations.
+- Truncation discards digits toward zero instead of rounding.
+- Empty filldown returns a new empty series rather than raising TypeError.
+- Savitzky-Golay filtering works with modern NumPy and retains all observations.
+
+### Maintenance
+
+- Removed dead HEC/Jython scaffolding and unreachable code; bare exception
+  handlers no longer swallow interrupts.
+
+### Regular-grid selection workflow
+
+Create a regular series as a timestamp mask, then select observations from
+another series using `cut()`:
+
+```python
+from datetime import datetime
+from tslite import timeseries
+
+source = timeseries([
+    (datetime(2024, 1, 1, 0), 10),
+    (datetime(2024, 1, 1, 1, 30), 15),
+    (datetime(2024, 1, 1, 2), 20),
+])
+grid = timeseries.createRegular(
+    start=datetime(2024, 1, 1, 0),
+    end=datetime(2024, 1, 1, 3),
+    interval="1h",
+)
+selected = grid.cut(source)
+# 00:00 -> 10, 02:00 -> 20
+```
+
+**Operand order matters:** `grid.cut(source)` keeps source values at timestamps
+present in the grid. `source.cut(grid)` would instead keep the grid's values.
+Matching is exact: this selects observations, without interpolating, snapping,
+or filling grid timestamps absent from the source.

tslite_og-2.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2009-2026 Gunnar Leffler
+
+   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.

tslite_og-2.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include LICENSE README.md CHANGELOG.md pyproject.toml pytest.ini
+recursive-include tests *.py
+include scripts/migrate_sqlite_milliseconds.py
+include test/source.dat test/test.db
+recursive-include test *.tsv *.json
+prune docs
+include doc/tslite.md
+prune site
+prune .github
+global-exclude __pycache__ *.py[cod]