Add public testing function to mock sample

[williambdean]

Description

Related to pymc-devs/pymc-extras#464

CC: @jessegrabowski

Related Issue

• Closes #
• Related to #

Checklist

• Checked that the pre-commit linting/style checks pass
• Included tests that prove the fix is effective or that the new feature works
• Added necessary documentation (docstrings and/or example notebooks)
• If you are a pro: each commit corresponds to a relevant logical change

Type of change

• New feature / enhancement
• Bug fix
• Documentation
• Maintenance
• Other (please specify):

[williambdean]

Maybe mock_sample isn't the best name for this function. Open to suggestions here

[jessegrabowski]

The name is OK for me, not sure what would be better

[williambdean]

I guess mock sounds like both a verb and adjective

[jessegrabowski]

It's clear from the context which is being used

[williambdean]

Another subtle item here is that Flat and HalfFlat will not be mocked with this function. But that is seems a bit separate

That was needed for this: https://github.com/williambdean/pymc-examples/blob/69563da49ceef589127140d3675a05b2ba4c3ae0/scripts/run_notebooks/injected.py#L72-L74

[jessegrabowski]

We could rewrite Flat and HalfFlat to Uniform and HalfUniform with big bounds (like -1e9 to 1e9) for the purposes of the tests? Is that too overkill?

[williambdean]

We could rewrite Flat and HalfFlat to Uniform and HalfUniform with big bounds (like -1e9 to 1e9) for the purposes of the tests? Is that too overkill?

I think that would be in the actual fixture since that provides the setup and breakdown. This function by itself doesn't

[jessegrabowski]

Yeah for sure. But a flat-to-uniform model transformation might potentially be in-scope for this PR

[williambdean]

Did HalfNormal and Normal. How's that?

And as for the use, does that seem reasonable for how others will define? It would require pytest to be an explicit dependency otherwise

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.84%. Comparing base (d34ed95) to head (d3a8c1c).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7761   +/-   ##
=======================================
  Coverage   92.83%   92.84%           
=======================================
  Files         107      107           
  Lines       18343    18367   +24     
=======================================
+ Hits        17028    17052   +24     
  Misses       1315     1315           

Files with missing lines	Coverage Δ
pymc/testing.py	90.30% <100.00%> (+0.52%)	⬆️

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ricardoV94]

We should add an entry to the docs

[williambdean]

We should add an entry to the docs

Done

[williambdean]

What else is required here?

[jessegrabowski]

lgtm

[jessegrabowski]

@fonnesbeck can we do a release so we can use this tool in extras?