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

Document markers.default_environment() #503

Closed
brettcannon opened this issue Jan 31, 2022 · 2 comments · Fixed by #753
Closed

Document markers.default_environment() #503

brettcannon opened this issue Jan 31, 2022 · 2 comments · Fixed by #753

Comments

@brettcannon
Copy link
Member

brettcannon commented Jan 31, 2022

def default_environment() -> Dict[str, str]:
iver = format_full_version(sys.implementation.version)
implementation_name = sys.implementation.name
return {
"implementation_name": implementation_name,
"implementation_version": iver,
"os_name": os.name,
"platform_machine": platform.machine(),
"platform_release": platform.release(),
"platform_system": platform.system(),
"platform_version": platform.version(),
"python_full_version": platform.python_version(),
"platform_python_implementation": platform.python_implementation(),
"python_version": ".".join(platform.python_version_tuple()[:2]),
"sys_platform": sys.platform,
}

The name and its inclusion in __all__ suggest this is part of the API and should be documented.

@brettcannon
Copy link
Member Author

@pradyunsg there's now a PR for this at #753 . Are you okay with making this part of the documented, public API?

@pradyunsg
Copy link
Member

Yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants