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.

Sign up for GitHub

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

Jump to bottom

add code and output samples for private tasks #178

Closed
wants to merge 1 commit into from
Closed

add code and output samples for private tasks #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions doc/tasks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,27 @@ private/hidden tasks

If task name starts with an underscore '_', it will not be included in the output.

.. literalinclude:: tutorial/private_task.py

.. code_block:: console

$ doit
. hello
$ doit dumpdb
Copy link
Member

Choose a reason for hiding this comment

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

I do not think this is a good example. The output is very lengthy and the dumpdb is an advanced command that most users would not know it exist or its purpose.

Better would be to have a private task that prints out something into the console. So you could see that it was executed although its name does not show up.

what do you think?

DBM type is 'dbm.gnu'
b'_private_get_username' -> { '_values_:': {},
Copy link
Member

Choose a reason for hiding this comment

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

oh. what an ugly output with those byte types b'xxx'

'checker:': 'MD5Checker',
'deps:': [],
'result:': '72c5fe66e904745607b30bff453bb75c'}
b'hello' -> { '_values_:': {},
'checker:': 'MD5Checker',
'deps:': [],
'result:': 'b1946ac92492d2347c6235b4d2611184'}
b'_other_get_username' -> { '_values_:': {},
'checker:': 'MD5Checker',
'deps:': [],
'result:': '46d3971fa3086160444faada1539e93b'}


title
-------
Expand Down
16 changes: 16 additions & 0 deletions doc/tutorial/private_task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
def task__private_get_username():
return {
'actions': ['echo whoami']
}


def task_other_private_get_username():
return {
'actions': ['echo $USER'],
'basename': '_other_get_username'
}

def task_hello():
return {
'actions': ['echo hello']
}