Dvc: Rename config to settings in Remote classes

Created on 15 Jan 2020  路  3Comments  路  Source: iterative/dvc

Refactoring based on the comment

Differentiate config (instance of Config class) and settings (content of the config section)

good first issue help wanted p3-nice-to-have refactoring

Most helpful comment

config and settings are inexact synonyms, using both in our code will make our heads explode even faster. We need to go away from sections instead and think about config as a single nested structure.

All 3 comments

config and settings are inexact synonyms, using both in our code will make our heads explode even faster. We need to go away from sections instead and think about config as a single nested structure.

I edit a set of files that need to be renamed to settings. Anyone can help check if the list is correct or not? I will start rename the variables once it's confirmed. Also please let me know if anything I miss. Many thanks

| Path | Need rename or not |
|:-------------------------------------:|:-----------------------:|
| dvc/command/base.py | - [] |
| dvc/command/cache.py | - [] |
| dvc/command/config.py | - [] |
| dvc/command/daemon.py | - [] |
| dvc/command/init.py | - [] |
| dvc/command/remote.py | - [] |
| dvc/remote/ssh/__init__.py | - [x] |
| dvc/remote/ssh/azure.py | - [x] |
| dvc/remote/ssh/base.py | - [x] |
| dvc/remote/ssh/gdrive.py | - [x] |
| dvc/remote/ssh/gs.py | - [x] |
| dvc/remote/ssh/hdfs.py | - [x] |
| dvc/remote/ssh/http.py | - [x] |
| dvc/remote/ssh/local.py | - [x] |
| dvc/remote/ssh/oss.py | - [x] |
| dvc/remote/ssh/s3.py | - [x] |
| dvc/remote/ssh/slow_link_detection.py | - [] |
| dvc/repo/__init__.py | - [] |
| dvc/repo/reproduce.py | - [] |
| dvc/analytics.py | - [] |
| dvc/cache.py | - [] |
| dvc/config.py | - [] |
| dvc/data_cloud.py | - [] |
| dvc/external_repo.py | - [] |
| dvc/state.py | - [] |

Hello @chlin501, thank you for your research! :rocket:
It looks correct (it relates remotes)
But let's up discussion one more time about need to rename the variable cause many maintainers are against the idea :crying_cat_face:

config and settings are inexact synonyms

The problem here that we name as config 2 objects that has different types. In fact we have
self.repo.config and config which are different
Before the changes by the PR such section had name settings and it had reasons to unify naming everywhere:
config is an instance of dvc.config.Config
settings is a part of the config

but now it's no so clear
cc @iterative/engineering

We need to go away from sections instead and think about config as a single nested structure.

@Suor do you have an idea how can it be done

Was this page helpful?
0 / 5 - 0 ratings

Related issues

anotherbugmaster picture anotherbugmaster  路  3Comments

TezRomacH picture TezRomacH  路  3Comments

ghost picture ghost  路  3Comments

jorgeorpinel picture jorgeorpinel  路  3Comments

shcheklein picture shcheklein  路  3Comments