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

Renaming the site_name parameter #1407

Closed
PythonCoderAS opened this issue Apr 22, 2020 · 5 comments
Closed

Renaming the site_name parameter #1407

PythonCoderAS opened this issue Apr 22, 2020 · 5 comments
Labels
Discussion Open for discussion

Comments

@PythonCoderAS
Copy link
Contributor

Describe the solution you'd like

The name site_name is not representative of the different sections of a config file. It seems to represent alternate reddit sites.

I propose renaming site_name to something more descriptive, like section_name, or config_section_name, although the second one is a bit wordy.

@jarhill0
Copy link
Contributor

Assuming you mean this.

As covered in documentation of praw.ini, the file allows you to actually configure PRAW to connect to some other instance of Reddit (such as if someone ran the archived open-source version) or access it through a different URL. While this use-case may not be common, it means that the site_name parameter can indeed be used to select an "alternate reddit site."

ConfigParser uses the name section, which may be more appropriate in general than site_name, especially considering that praw.ini files are, for the most part, used for configuring authentication information.

On balance, however, I think that the impact of the breaking change of renaming an argument in the initializer of the main class of this entire project is not worth the benefit of having a slightly nicer name.

@PythonCoderAS
Copy link
Contributor Author

@bboe Can I get your opinion on this? I think we can introduce the change in PRAW 8.0, as this release already has way too many breaking changes.

@PythonCoderAS PythonCoderAS added the Discussion Open for discussion label Apr 23, 2020
@bboe
Copy link
Member

bboe commented Apr 23, 2020

I'm okay with this change assuming there is a deprecation period first.

@PythonCoderAS
Copy link
Contributor Author

I'll introduce the deprecation period in 7.0, and remove in 8.0.

@PythonCoderAS PythonCoderAS modified the milestone: PRAW 7.0 Apr 23, 2020
@bboe
Copy link
Member

bboe commented May 20, 2021

Author no longer active on this project :'(. Closing author's issues.

@bboe bboe closed this as completed May 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Open for discussion
Projects
None yet
Development

No branches or pull requests

3 participants