Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API dump and deeper trulens_eval compatibility test #1309

Merged
merged 120 commits into from
Aug 23, 2024

Conversation

sfc-gh-pmardziel
Copy link
Contributor

@sfc-gh-pmardziel sfc-gh-pmardziel commented Jul 29, 2024

Description

Some utilities to collect module contents and a dump of the current names in the trulens_eval package. This is to be used for backwards compatibility tests. Also added dump of the new trulens package to make sure we are aware of API changes when they happen.

Other details good to know for developers

Factored out module enumeration and related from static tests to import utilities. Making use of this for some backwards compatibility checks.

Added api_test that compares the qualified names and types of all public members of trulens modules and classes to a fixed golden set. In the future, will also add function signatures to this ground truth.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)
  • New Tests
  • This change includes re-generated golden test results
  • This change requires a documentation update

@sfc-gh-pmardziel sfc-gh-pmardziel marked this pull request as ready for review August 19, 2024 23:38
@sfc-gh-pmardziel sfc-gh-pmardziel changed the title [draft] get_definitions utility and api dump API dump and deeper trulens_eval compatibility test Aug 19, 2024
@sfc-gh-pmardziel sfc-gh-pmardziel merged commit b081eb4 into main Aug 23, 2024
7 checks passed
@sfc-gh-pmardziel sfc-gh-pmardziel deleted the piotrm/get_definitions branch August 23, 2024 01:20
sfc-gh-dhuang pushed a commit that referenced this pull request Aug 24, 2024
* dummy testing

* writing record dump from dummy app invocation

* write golden files

* add golden tests

* docs

* add docs

* template adjustment

* fix mkdocs warnings

* fix old test

* change goldens to yaml for human readability

* backtrack to json due to yaml issues, add checking of feedback result as well

* more skipped json parts

* format

* add some additional checks on bindings

* nit

* add todo near comments

* grammar fix

* more docs

* more docs

* cleanup

* fix validate nondeterminism

* update gold

* pretty print golden json output

* extension warning

* icons for dummy docs

* fix docs

* format

* adjust template wording

* update custom_example notebook

* update docs around custom_example

* update golden tests for custom app

* fix outdated recording usage

* adding custom app options

* adding more example usage

* fixing up async uses

* format

* format again

* add streaming to dummy app

* update golden

* add comparison for unordered sequences

* add frozendict to test reqs

* typo

* reorganize dummy app

* cleaning up docs

* updating docs and adding references

* remove str from enums

* revert and add comment about str Enums

* format

* update golden files

* adjust  name argument default in some signatures

* PR comments

* undo accidental addition

* Factoring out part of static tests.

* nit

* format

* work

* api test case

* address PR comments

* remove unused

* format

* format again

* add api golden list

* format

* pre-commit format

* Add pydantic attributes to api printout

* fix forward ref rendering for api dump

* fix test imports

* fix test path

* fix import

* format

* typo again

* make api test optional

* another typo

* type typo

* fixes for python before 3.11

* use subtests in json compare

* minor

* remove old example from package root, another copy was in examples outside of package

* typo

* move api reference docs

* remove unused docs

* remove old stuff

* revert goldens

* fixing merge

* rename test

* Rename.

* fix makefile

* Fixing api dumps and splitting by pyversion.

* skip version in json compare

* fix static test

* missing todo

* skip _bundle mod

* remove duplicate targets

* fix to some imports

* another fix

* write golden api

* add jsondiff to test deps

* add 3.11 api dump

* add 3.9 and 3.10 api dumps

* run on py311 only

* test only on 3.11

* api changes

* fixing session

* fixing session args

* make app_id a read only instead of computed field

* forgot to regen api

* read_only -> frozen
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants