orgdatacore 2.0.0__tar.gz

orgdatacore-2.0.0/.gitignore

@@ -0,0 +1,33 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+*.egg-info/
+*.egg
+dist/
+build/
+
+# Virtual environments
+venv/
+.venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# mypy
+.mypy_cache/
+
+# UV (virtual environment is in .venv, already ignored above)
+# Note: uv.lock should be committed for reproducible builds
+

orgdatacore-2.0.0/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to the `orgdatacore` Python package are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Nothing yet.
+
+## [2.0.0] — unreleased
+
+Adopt the canonical [`orgindex-schema`](https://github.com/openshift-eng/orgindex-schema)
+models as the single source of truth for the on-disk index shape (OCPCRT-658).
+This is a breaking change to the **model shape**; the query-method API and load
+behavior are unchanged (verified against a real production index — cross-branch
+differential test: 36,348 cases, 0 mismatches).
+
+### Added
+- `orgindex-schema` is now a **required** dependency
+  (`orgindex-schema>=0.1.0,<0.2.0`, published on PyPI). It is pulled in
+  automatically by pip/uv when installing `orgdatacore`; no manual install is
+  needed. The upper bound caps at the next minor because the schema is pre-1.0
+  (a `0.2.0` may be breaking under SemVer).
+- `Employee.possible_github_ids` field (from the canonical schema).
+- `cohorts` lookup collection on `Lookups`.
+- PII redaction/anonymization now scrub `possible_github_ids` and also cover the
+  `cohorts` collection.
+
+### Changed
+- On-disk index/entity models are re-exported from `orgindex-schema` under their
+  historical names. `Team`/`Org`/`Pillar`/`TeamGroup` are now the single
+  `HierarchyEntity`; `Component` is `ComponentEntry` with its detail nested under
+  `.component`; `Data` is `ComprehensiveIndexModel`.
+- Model collection fields are now `list` (previously `tuple`). Frozen models that
+  hold populated list fields are therefore no longer hashable.
+- `RepoInfo.repo` is now `repo_name`; the group role list is `resolved_roles`
+  (previously `roles`).
+- Serialization goes through `model_dump`, so cleared/empty optional fields are
+  emitted as `""` / `[]` rather than omitted from the JSON.
+
+### Removed
+- `Employee.rhat_geo`, `Employee.cost_center`, `Employee.is_people_manager`
+  (not present in real producer output).
+- Top-level `uid`, `tab_name`, and `type` on hierarchy entities
+  (`Team`/`Org`/`Pillar`/`TeamGroup`); identity is carried by `stable_id` /
+  `parent_id`.
+- `Metadata.total_teams`.
+- The `JiraIndex` and `ComponentOwnershipIndex` exports (these indexes are bare
+  maps, matching the Go `map` types).
+
+### Migration notes
+- Code that only **calls `Service` query methods** needs no changes.
+- Code that reads the removed/renamed fields, imports `JiraIndex` /
+  `ComponentOwnershipIndex`, relies on `tuple`-typed collections, or hashes model
+  instances must be updated.
+
+## [1.0.0]
+
+Initial tracked release (pre-canonical models). Hand-maintained pydantic models
+describing the on-disk index, consumed by `Service`.
+
+[Unreleased]: https://github.com/openshift-eng/cyborg-data/compare/python-v2.0.0...HEAD
+[2.0.0]: https://github.com/openshift-eng/cyborg-data/releases/tag/python-v2.0.0

orgdatacore-2.0.0/CLAUDE.md

@@ -0,0 +1,313 @@
+# Python Implementation Guide
+
+## Quick Reference
+
+```bash
+cd python
+pytest                    # Run all tests
+pytest tests/test_employee.py  # Run specific tests
+ruff check . && ruff format .  # Lint and format
+mypy orgdatacore          # Type check
+```
+
+## Extending the API
+
+### Adding a New Query Method
+
+Follow this exact pattern for every new method:
+
+#### Step 1: Implement in Service (`_service.py`)
+
+```python
+def get_new_thing_by_param(self, param: str) -> NewThing | None:
+    """Get a NewThing by param.
+
+    Args:
+        param: The parameter to look up.
+
+    Returns:
+        The NewThing if found, None otherwise.
+    """
+    with self._lock:
+        # ALWAYS check for None data first
+        if self._data is None or not self._data.lookups.some_map:
+            return None
+
+        # Use O(1) lookup - NEVER traverse
+        return self._data.lookups.some_map.get(param)
+```
+
+#### Step 2: Add Tests (`tests/test_*.py`)
+
+```python
+class TestGetNewThingByParam:
+    """Tests for new thing lookup by param."""
+
+    @pytest.mark.parametrize("param,expected", [
+        ("valid", NewThing(uid="valid", name="Valid Thing")),
+        ("nonexistent", None),
+        ("", None),
+    ])
+    def test_get_new_thing_by_param(
+        self, service: Service, param: str, expected: NewThing | None
+    ):
+        """Test new thing lookup by param."""
+        result = service.get_new_thing_by_param(param)
+        assert result == expected
+```
+
+### Design Rules
+
+1. **Thread Safety**: Always use `with self._lock:` for data access
+2. **None Checks**: Check `self._data` and the specific collection before accessing
+3. **Return Optional**: Return `Type | None` for single entities
+4. **Return Lists**: Return `list[Type]` for collections (empty list, not None)
+5. **Type Hints**: All parameters and returns must be typed
+
+### Performance Guidelines
+
+**Hot path methods** (called frequently, latency-sensitive):
+- MUST use pre-computed indexes for O(1) lookup
+- Examples: `get_employee_by_slack_id`, `is_employee_in_team`, `get_teams_for_uid`
+
+**Cold path methods** (infrequent, admin/debug use):
+- MAY traverse data if index cost outweighs benefit
+- Document the O(n) complexity in docstring
+- Examples: `get_employee_by_email`, `get_all_employee_uids`
+
+When adding a new method, consider:
+- How often will this be called?
+- Is there an existing index that covers this case?
+- Would a new index significantly grow the data file?
+
+If traversal is acceptable, document it:
+```python
+def get_employee_by_email(self, email: str) -> Employee | None:
+    """Get an employee by email address.
+
+    Note: O(n) scan - use get_employee_by_uid for hot paths.
+    """
+```
+
+### Method Categories
+
+| Category | Return Type | None Check Pattern |
+|----------|-------------|-------------------|
+| Single entity lookup | `Employee \| None` | Return `None` if not found |
+| Collection lookup | `list[str]` | Return empty list `[]` |
+| Boolean check | `bool` | Return `False` if data unavailable |
+| Version/metadata | `DataVersion` | Return default instance |
+
+### Lookup Patterns
+
+**Direct dict lookup** (e.g., get_employee_by_uid):
+```python
+def get_employee_by_uid(self, uid: str) -> Employee | None:
+    with self._lock:
+        if self._data is None or not self._data.lookups.employees:
+            return None
+        return self._data.lookups.employees.get(uid)
+```
+
+**Two-step lookup** (e.g., get_employee_by_slack_id):
+```python
+def get_employee_by_slack_id(self, slack_id: str) -> Employee | None:
+    with self._lock:
+        if (
+            self._data is None
+            or not self._data.indexes.slack_id_mappings.slack_uid_to_uid
+            or not self._data.lookups.employees
+        ):
+            return None
+
+        uid = self._data.indexes.slack_id_mappings.slack_uid_to_uid.get(slack_id, "")
+        if not uid:
+            return None
+
+        return self._data.lookups.employees.get(uid)
+```
+
+**Membership iteration** (e.g., get_teams_for_uid):
+```python
+def get_teams_for_uid(self, uid: str) -> list[str]:
+    with self._lock:
+        if self._data is None or not self._data.indexes.membership.membership_index:
+            return []
+
+        memberships = self._data.indexes.membership.membership_index.get(uid, ())
+        return [m.name for m in memberships if m.type == MembershipType.TEAM]
+```
+
+## File Organization
+
+| File | Purpose |
+|------|---------|
+| `_service.py` | `Service` class implementation |
+| `_types.py` | Data structures (Employee, Team, etc.) |
+| `_exceptions.py` | Custom exceptions |
+| `_log.py` | Logging utilities |
+| `_gcs.py` | GCS data source (optional) |
+| `__init__.py` | Public API exports |
+
+### Test File Mapping
+
+| Entity | Test File |
+|--------|-----------|
+| Employee queries | `tests/test_employee.py` |
+| Team queries | `tests/test_team.py` |
+| Org queries | `tests/test_organization.py` |
+| Pillar queries | `tests/test_pillar.py` |
+| TeamGroup queries | `tests/test_team_group.py` |
+| Service lifecycle | `tests/test_service.py` |
+| Edge cases | `tests/test_edge_cases.py` |
+
+## Adding a New Entity Type
+
+1. Add model to `_types.py`:
+```python
+class NewEntity(BaseModel):
+    """Represents a new entity in the organizational data."""
+
+    model_config = ConfigDict(frozen=True)
+
+    uid: str = ""
+    name: str = ""
+    # ... fields match JSON structure
+```
+
+2. Add to `Lookups` model:
+```python
+class Lookups(BaseModel):
+    # ... existing fields ...
+    new_entities: dict[str, NewEntity] = Field(default_factory=dict)
+```
+
+3. Add parser function in `_service.py`:
+```python
+def _parse_new_entity(data: dict[str, Any]) -> NewEntity:
+    """Parse a NewEntity from a dictionary."""
+    return NewEntity(
+        uid=data.get("uid", ""),
+        name=data.get("name", ""),
+    )
+```
+
+4. Update `_parse_data()` to include the new entity
+
+5. Add query method following the pattern above
+
+6. Add tests and update `testdata/test_org_data.json`
+
+## Adding a New Index Mapping
+
+For new external ID → UID mappings:
+
+1. Add mapping model to `_types.py`:
+```python
+class NewIDMappings(BaseModel):
+    """Contains New ID to UID mappings."""
+
+    model_config = ConfigDict(frozen=True)
+
+    new_id_to_uid: dict[str, str] = Field(default_factory=dict)
+```
+
+2. Add to `Indexes` model:
+```python
+class Indexes(BaseModel):
+    # ... existing fields ...
+    new_id_mappings: NewIDMappings = Field(default_factory=NewIDMappings)
+```
+
+3. Update `_parse_data()` to parse the new mappings
+
+4. Add lookup method following the two-step pattern
+
+## Type Hints
+
+All code must pass `mypy --strict`:
+
+```python
+# Correct: Union with None for optional returns
+def get_employee_by_uid(self, uid: str) -> Employee | None:
+
+# Correct: List for collections
+def get_all_team_names(self) -> list[str]:
+
+# Correct: Tuple for immutable sequences in models
+class SlackConfig(BaseModel):
+    model_config = ConfigDict(frozen=True)
+    channels: tuple[ChannelInfo, ...] = ()
+```
+
+## Pydantic Model Conventions
+
+Always use frozen pydantic BaseModel:
+```python
+class Employee(BaseModel):
+    model_config = ConfigDict(frozen=True)
+
+    uid: str = ""
+    full_name: str = ""
+    # Default values for all fields
+```
+
+- `frozen=True`: Immutability for thread safety
+- Only add `populate_by_name=True` if the model has aliased fields (`Field(alias=...)`)
+- Use `Field(default_factory=...)` for mutable defaults (dicts, lists)
+
+## Protocol-Based DataSource
+
+DataSource uses Protocol (structural typing):
+```python
+class DataSource(Protocol):
+    def load(self) -> BinaryIO: ...
+    def watch(self, callback: Callable[[], Exception | None]) -> Exception | None: ...
+    def __str__(self) -> str: ...
+```
+
+No inheritance required - just implement the methods.
+
+## Logging
+
+Use the standard library logger:
+```python
+from ._log import get_logger
+
+logger = get_logger()
+logger.info("action completed", extra={"key": value})
+logger.error("action failed", extra={"error": str(e)})
+```
+
+## Optional Dependencies
+
+GCS support via extras:
+```bash
+pip install orgdatacore[gcs]
+```
+
+Check availability at runtime:
+```python
+try:
+    from google.cloud import storage
+    HAS_GCS = True
+except ImportError:
+    HAS_GCS = False
+```
+
+## Test Fixtures
+
+Use pytest fixtures from `conftest.py`:
+```python
+@pytest.fixture
+def service() -> Service:
+    """Create a service with test data loaded."""
+    # Uses shared testdata/test_org_data.json
+    ...
+```
+
+## Remember
+
+After implementing in Python:
+1. **Implement the same method in Go** (see `go/CLAUDE.md`)
+2. Run `make test` from repository root to verify parity

orgdatacore-2.0.0/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 2026 Red Hat, LLC.
+
+   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.