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.

Sign up for GitHub

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

Jump to bottom

request fixture contains a path property, but this is not in the documentation #9975

Closed
dorak88783 opened this issue May 18, 2022 · 6 comments
Closed

request fixture contains a path property, but this is not in the documentation #9975

dorak88783 opened this issue May 18, 2022 · 6 comments
Labels
good first issue easy issue that is friendly to new contributor topic: fixtures anything involving fixtures directly or indirectly type: docs documentation improvement, missing or needing clarification type: enhancement new feature or API change, should be merged into features branch

Comments

@dorak88783
Copy link

In https://docs.pytest.org/en/7.1.x/_modules/_pytest/fixtures.html#FixtureRequest there is a (nice) property def path(self) -> Path, but this is not in the documentation at https://docs.pytest.org/en/7.1.x/reference/reference.html#std-fixture-request.

Is this as expected?
@RonnyPfannschmidt RonnyPfannschmidt added topic: fixtures anything involving fixtures directly or indirectly type: docs documentation improvement, missing or needing clarification type: enhancement new feature or API change, should be merged into features branch good first issue easy issue that is friendly to new contributor labels May 18, 2022
@nicoddemus
Copy link
Member

Hi @dorak88783,

Thanks for reporting.

IIRC we decide to leave this undocumented for now while we slowly remove the dependency to py, see #9283. @The-Compiler @bluetech might correct me if I'm wrong.

@The-Compiler
Copy link
Member

I don't think this is intended. The .path property was introduced by @RonnyPfannschmidt in 22dad53, and back there, the old fspath was documented too (that then got dropped in 7c00113, probably somewhat unintentionally too).

@nicoddemus
Copy link
Member

Hmm I had a vague recollection of we leaving it undocumented on purpose, but I'm remembering it wrong then

@paulreece
Copy link
Contributor

Hi, I created a PR here to fix this issue.

@paulreece
Copy link
Contributor

@nicoddemus Just checking in if anything else is needed for this. I created a PR here

nicoddemus added a commit that referenced this issue Jun 25, 2022
@nicoddemus
Merge pull request #10056 from paulreece/fixture-path-doc-fix
aafac55 
Added Docstring description for the Path property of FixtureRequest #9975
@nicoddemus
Copy link
Member

Ahh I missed, thanks for the ping. 👍

Just merged it, thanks again.

github-actions bot pushed a commit that referenced this issue Jun 25, 2022
@nicoddemus @pytestbot
[7.1.x] Added Docstring description for the Path property of FixtureR…
9c3bc10 
…equest #9975
nicoddemus added a commit that referenced this issue Jun 26, 2022
@nicoddemus
Merge pull request #10075 from pytest-dev/backport-10056-to-7.1.x
7127b56 
[7.1.x] Added Docstring description for the Path property of FixtureRequest #9975
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue easy issue that is friendly to new contributor topic: fixtures anything involving fixtures directly or indirectly type: docs documentation improvement, missing or needing clarification type: enhancement new feature or API change, should be merged into features branch
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@RonnyPfannschmidt @The-Compiler @nicoddemus @dorak88783 @paulreece