Unbind the config_dict from cookiecutter(). Allow it to be passed as an argument. by theladyjaye · Pull Request #100 · cookiecutter/cookiecutter

theladyjaye · 2013-10-22T11:08:08Z

Allow the initial config_dict to be passed as an argument to the cookiecuter() function rather than impose the default user config from within cookiecutter().

Note that main() still runs though get_user_config() for the CLI aspect of Cookiecutter. For the user that is composing Cookiecutter in a larger python program, they can decide what config_dict is when calling cookiecutter() from within python assuming they make it conform to the expected keys defined in config.DEFAULT_CONFIG

…iecuter() function rather than impose the default user config. Note that main() still runs though get_user_config() but for the user that is composing cookiecutter in a larger python program, they can decide what the config_dict is when calling cookiecutter from within python.

coveralls · 2013-10-22T11:09:11Z

Coverage decreased (-0.92%) when pulling 4ad877e on aventurella:master into 4363909 on audreyr:master.

theladyjaye · 2013-10-22T11:12:56Z

Ahhh... this is sort of duplicating pull #75 and answering issue #12

My 2c on the difference between the 2 (#100 and #75) conceptually:

#75 still runs though get_user_config() in cookiecutter() which assumes you want to lookup the config from the user path. Granted when this fails you get a copy of DEFAULT_CONFIG but it still leaves the API consumer of cookiecutter() performing a filesystem operation they may not necessarily know they are doing.

For example, they might be using Cookiecutter on the CLI normally which would mean they potentially have a ~/.cookiecutterrc. Now if they decide to create an application that composes Cookiecutter, even though they are no longer using it on the CLI for their purpose, it will still go and read their ~/.cookiecutterrc when calling it from python potentially loading config information they never intended to load. If the API user really wants to load the user's config, I think it's better to have them explicitly load it on their end, AKA in their program they call config.get_user_config() rather than having it automatically called for them.

#100 However must dupe a little bit of functionality found in cookiecutter.config namely the copying of the DEFAULT_CONFIG dict. The API user then needs to perform that copy themselves if they want to pass their own config_dict to cookiecutter(). Actually, I'm going to amend this PR and add a get_default_config() to cookiecutter.config. This will allow an API user a convenience function to call to get the config and not have to know anything about the copying going on behind the scenes. Additionally, config.get_config() and config.get_user_config() can both make use of it as they were both performing a call to copy.copy(DEFAULT_CONFIG) previously.

coveralls · 2013-10-22T11:31:31Z

Coverage remained the same when pulling 3104cda on aventurella:master into 4363909 on audreyr:master.

coveralls · 2013-10-22T11:39:50Z

Coverage decreased (-1.54%) when pulling 8a4e8d6 on aventurella:master into 4363909 on audreyr:master.

dinopetrone · 2013-10-22T15:54:07Z

+1

aubricus · 2013-10-22T20:11:12Z

+1

rochacbruno · 2013-10-30T15:55:30Z

👍

coveralls · 2013-11-04T23:21:43Z

Coverage decreased (-1.94%) when pulling 1887cb4 on aventurella:master into 4363909 on audreyr:master.

This reverts commit 1887cb4.

coveralls · 2013-11-05T11:35:43Z

Coverage remained the same when pulling ef58237 on aventurella:master into 4363909 on audreyr:master.

pydanny · 2013-11-12T17:12:14Z

👍

driesdesmet · 2013-11-20T23:48:40Z

If I understand this correctly, this would allow me to overwrite the default_context both on the command line and using python with higher priority than what's set in cookiecutter.json: +1

michaeljoseph · 2013-11-23T10:59:44Z

cookiecutter/main.py

michaeljoseph · 2013-11-23T11:00:06Z

@aventurella this needs tests please.

michaeljoseph · 2013-11-23T11:02:52Z

cookiecutter/main.py

michaeljoseph · 2013-11-26T06:28:31Z

🔔 @aventurella

theladyjaye · 2013-11-26T11:25:37Z

@michaeljoseph ya, I will get those tests in there, no problem.

Remove improper doc string in cookiecutter.main.cookiecutter. Add unit test for cookiecutter.main.cookiecutter to test passing in a custom config_dict.

coveralls · 2013-11-26T16:22:40Z

Coverage decreased (-0.28%) when pulling 54992ae on aventurella:master into 4363909 on audreyr:master.

michaeljoseph · 2013-12-07T07:56:45Z

cookiecutter/main.py

☔ whether

I don't know what this means =)

mgaitan · 2014-03-21T14:47:24Z

Hi guys,

this is a bit off topic, but we are in a hack camp in Argentina for the weekend, (#pycamp2014) talking about if we should fork this project. There are many importants PR like this one without any feedback from the core developers.

here some rant
https://twitter.com/tin_nqn_/status/447020239897628672

What do you think ?

michaeljoseph · 2014-08-07T10:26:01Z

👀 #260

…l-tiers-needs-to-be-slugified slugify CODEOWNERS.md at Tiers 2-4

added get_default_config() to cookiecutter.config

3104cda

removed errant copy import

8a4e8d6

updating hooks to have context and post/pre done in correct env

1887cb4

Revert "updating hooks to have context and post/pre done in correct env"

ef58237

This reverts commit 1887cb4.

michaeljoseph mentioned this pull request Nov 16, 2013

Add ability to pass in a context file #116

Closed

michaeljoseph reviewed Nov 23, 2013
View reviewed changes

cookiecutter/main.py Outdated

Copy link
Copy Markdown

Contributor

michaeljoseph Nov 23, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔥

michaeljoseph reviewed Nov 23, 2013
View reviewed changes

cookiecutter/main.py Outdated

Copy link
Copy Markdown

Contributor

michaeljoseph Nov 23, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

☔

audreyfeldroy mentioned this pull request Nov 25, 2013

Make cookiecutter and diecutter converge #124

Closed

Unit Test: Unbind config_dict from cookiecutter()

54992ae

Remove improper doc string in cookiecutter.main.cookiecutter. Add unit test for cookiecutter.main.cookiecutter to test passing in a custom config_dict.

michaeljoseph reviewed Dec 7, 2013
View reviewed changes

michaeljoseph mentioned this pull request Jul 12, 2014

Add optional overrides param to cookiecutter() #12

Closed

michaeljoseph added the enhancement label Jul 13, 2014

michaeljoseph added this to the 0.8.0 - Extra Context milestone Jul 13, 2014

michaeljoseph removed this from the 0.7.1 milestone Jul 13, 2014

michaeljoseph mentioned this pull request Aug 7, 2014

Extra context: API + CLI #260

Closed

michaeljoseph closed this Aug 7, 2014

JosephGasiorekUSDS pushed a commit to JosephGasiorekUSDS/cookiecutter that referenced this pull request Jun 30, 2024

Merge pull request cookiecutter#100 from DSACMS/37-codeownersmd-at-al…

6160a03

…l-tiers-needs-to-be-slugified slugify CODEOWNERS.md at Tiers 2-4

Conversation

theladyjaye commented Oct 22, 2013

Uh oh!

coveralls commented Oct 22, 2013

Uh oh!

theladyjaye commented Oct 22, 2013

Uh oh!

coveralls commented Oct 22, 2013

Uh oh!

coveralls commented Oct 22, 2013

Uh oh!

dinopetrone commented Oct 22, 2013

Uh oh!

aubricus commented Oct 22, 2013

Uh oh!

rochacbruno commented Oct 30, 2013

Uh oh!

coveralls commented Nov 4, 2013

Uh oh!

coveralls commented Nov 5, 2013

Uh oh!

pydanny commented Nov 12, 2013

Uh oh!

driesdesmet commented Nov 20, 2013

Uh oh!

michaeljoseph Nov 23, 2013

Choose a reason for hiding this comment

Uh oh!

michaeljoseph commented Nov 23, 2013

Uh oh!

michaeljoseph Nov 23, 2013

Choose a reason for hiding this comment

Uh oh!

michaeljoseph commented Nov 26, 2013

Uh oh!

theladyjaye commented Nov 26, 2013

Uh oh!

coveralls commented Nov 26, 2013

Uh oh!

michaeljoseph Dec 7, 2013

Choose a reason for hiding this comment

Uh oh!

theladyjaye Dec 10, 2013

Choose a reason for hiding this comment

Uh oh!

mgaitan commented Mar 21, 2014

Uh oh!

michaeljoseph commented Aug 7, 2014

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants