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

Deprecate the Parameter attribute pickle_default_value? #1007

Open
maximlt opened this issue Jan 14, 2025 · 0 comments · May be fixed by #1019
Open

Deprecate the Parameter attribute pickle_default_value? #1007

maximlt opened this issue Jan 14, 2025 · 0 comments · May be fixed by #1019
Labels
status: discussion Discussion. Not yet a specific feature/bug. Likely to result in multiple PRs/issues.
Milestone

Comments

@maximlt
Copy link
Member

maximlt commented Jan 14, 2025

pickle_default_value is defined as follows:

        pickle_default_value: whether the default value should be
        pickled. Usually, you would want the default value to be pickled,
        but there are rare cases where that would not be the case (e.g.
        for file search paths that are specific to a certain system).

and set to False (True by default) in resolve_path.search_paths and resolve_path.path_to_file. It has been in Param since at least its first commit on Github.

However, Param doesn't make any direct use of it internally, i.e. pickling a Parameterized object will not take into account its value, users have to write custom. The only usage I could find of it on Github is in topographica (https://github.com/search?q=repo%3Aioam%2Ftopographica%20pickle_default_value&type=code). There are no references to this Parameter attribute in Param's own issues or PRs (https://github.com/search?q=repo%3Aholoviz%2Fparam+pickle_default_value&type=issues).

I would suggest deprecating this Parameter attribute.

@maximlt maximlt added the status: discussion Discussion. Not yet a specific feature/bug. Likely to result in multiple PRs/issues. label Jan 14, 2025
@maximlt maximlt added this to the v2.3.0 milestone Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: discussion Discussion. Not yet a specific feature/bug. Likely to result in multiple PRs/issues.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant