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

ENH progressbars for addurl #2738

Merged
merged 6 commits into from Aug 15, 2018

Conversation

Projects
None yet
2 participants
@yarikoptic
Member

yarikoptic commented Aug 4, 2018

This pull request fixes datalad/datalad-container#49

I guess would require manual testdriving since it is UI which we might not test very thoroughly automatically. But on my attempts seems to be quite kosher.

yarikoptic added some commits Aug 3, 2018

BF: fixup handling of progress reports so they work also for addurl
tricky part is that addurl does not report a file for which it reports:
http://git-annex.branchable.com/todo/provide___39__file__39___in_--json-progress_record_for_addurl/
so code now relies on the fact that if it is only one expected item to be
dealt with then we do not need to match it by download_id which could be
defined by a key or a file.  Eventually this all might need to be RFed.

I also disabled total progress bar in case if there is only a single item
expected to be downloaded since it makes little to no sense then
(unless I missed why we had it that way... like if when we do not know
that there would be more than one
BF(blind): do not update progressbars if size is 0
I think previous changes actually did break something, leading to this
behavior that updates are provided Nones etc.
See https://travis-ci.org/datalad/datalad/jobs/411998919
but failed to reproduce locally :-/
Merge remote-tracking branch 'origin/master' into enh-progress-addurl
* origin/master: (51 commits)
  BF: Recreate old GitRepo.get_git_attributes() to keep old folks going
  TST: Test not up to the complexity of the world
  DOC: Remove question that is not relevant
  BF: Humble attempt to fix unicode issue
  TST: More or less comprehensive GitRepo.(g|s)et_attributes test
  travis: Add a comment about grunt-contrib-qunit pinning
  DOC: set_gitattributes: Fix a minor typo
  TST: travis: Pin grunt-contrib-qunit
  BF: no_annex: Correct path to .gitattributes
  TST: Plain RF to remove 'import *' madness
  RF: no_annex plugin used attributes helper
  RF: `create` no longer hacks .gitattributes, no duplication on --force
  DOC: search: Fix a typo
  RF+ENH: New search mode egrepcs for case-sensitive search
  NF: GitRepo.set_gitattributes
  RF+ENH: Improved GitRepo.get_gitattributes
  TST: Adjust test for WTF output change, minor polish
  BF: Must use preprocessed variable
  ENH: wtf returns structured data (fixes gh-2415, gh-2734)
  DOC: Document new egrep search behavior
  ...
@codecov

This comment has been minimized.

codecov bot commented Aug 8, 2018

Codecov Report

Merging #2738 into master will increase coverage by 0.05%.
The diff coverage is 88.57%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2738      +/-   ##
==========================================
+ Coverage   90.42%   90.48%   +0.05%     
==========================================
  Files         245      245              
  Lines       31210    31467     +257     
==========================================
+ Hits        28223    28472     +249     
- Misses       2987     2995       +8
Impacted Files Coverage Δ
datalad/ui/progressbars.py 87.12% <100%> (-2.57%) ⬇️
datalad/support/annexrepo.py 89.33% <87.09%> (-0.27%) ⬇️
datalad/interface/utils.py 94.26% <0%> (-0.41%) ⬇️
datalad/distribution/subdatasets.py 94.73% <0%> (+0.03%) ⬆️
datalad/interface/tests/test_run.py 99.86% <0%> (+0.04%) ⬆️
datalad/interface/rerun.py 97.56% <0%> (+1.22%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d0d332c...07ae00f. Read the comment docs.

@kyleam

I tried this out on a few containers-add calls. Looks nice! I've left a few minor comments.

progress=True,
expected_entries={file_: None},
#log_online=True,
#log_stderr=False,

This comment has been minimized.

@kyleam

kyleam Aug 9, 2018

Member

Why leave commented out code?

This comment has been minimized.

@yarikoptic

yarikoptic Aug 9, 2018

Member

dunno... dirty yarik. will remove

@@ -2279,6 +2283,8 @@ def _run_annex_command_json(self, command,
expected_entries : dict, optional
If provided `filename/key: size` dictionary, will be used to create
ProcessAnnexProgressIndicators to display progress
progress: bool, optional
Either request/handle --json-progress

This comment has been minimized.

@kyleam

kyleam Aug 9, 2018

Member

s/Either/Whether to/

@@ -3650,8 +3676,8 @@ def __call__(self, line):
# so we have a progress indicator, let's deal with it
action = j['action']
download_item = action.get('file') or action.get('key')
download_id = (action['command'], action['key'])
download_item = action.get('key') or action.get('file')

This comment has been minimized.

@kyleam

kyleam Aug 9, 2018

Member

"download_item" seems like a weird name at the level of ProcessAnnexProgressIndicators. Regardless of where this is used at the moment, couldn't the item correspond to an upload or a local copy or any other action on a file/key?

This comment has been minimized.

@yarikoptic

yarikoptic Aug 9, 2018

Member

indeed! I guess it i more of an action_item, will change now. thanks...
edit: the same for download_id - should be action_id

@yarikoptic

This comment has been minimized.

Member

yarikoptic commented Aug 14, 2018

I've restarted a travis build (hopefully uploaded fresh git-annex resolves the issue) since failure looked unrelated. I am afraid I did break something with this PR since my checks I had to add hint that something is behaving differently now. But I am afraid that due to this "interactive" nature of the element here, we would only discover by trying it out.
I will merge tomorrow if no new problems emerge

@yarikoptic yarikoptic merged commit 0287e70 into datalad:master Aug 15, 2018

8 of 9 checks passed

codecov/patch 88.57% of diff hit (target 90.42%)
Details
codecov/project 90.48% (+0.05%) compared to d0d332c
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
datalad-pr-dl-osx-64 DEV build done.
Details
datalad-pr-docker-dl-nd14_04 DEV build done.
Details
datalad-pr-docker-dl-nd16_04 DEV build done.
Details
datalad-pr-docker-dl-nd80 DEV build done.
Details
datalad-pr-docker-dl-nd90 DEV build done.
Details

@yarikoptic yarikoptic added this to the Release 0.10.3 milestone Sep 12, 2018

yarikoptic added a commit that referenced this pull request Sep 13, 2018

Merge tag '0.10.3' into debian
0.10.3 (Sep 13, 2018) -- Almost-perfect

This is largely a bugfix release which addressed many (but not yet all)
issues of working with git-annex direct and version 6 modes, and operation
on Windows in general.  Among enhancements you will see the
support of public S3 buckets (even with periods in their names),
ability to configure new providers interactively, and improved `egrep`
search backend.

Although we do not require with this release, it is recommended to make
sure that you are using a recent `git-annex` since it also had a variety
of fixes and enhancements in the past months.

Fixes

- Parsing of combined short options has been broken since DataLad
  v0.10.0. ([#2710])
- The `datalad save` instructions shown by `datalad run` for a command
  with a non-zero exit were incorrectly formatted. ([#2692])
- Decompression of zip files (e.g., through `datalad
  add-archive-content`) failed on Python 3.  ([#2702])
- Windows:
  - colored log output was not being processed by colorama.  ([#2707])
  - more codepaths now try multiple times when removing a file to deal
    with latency and locking issues on Windows.  ([#2795])
- Internal git fetch calls have been updated to work around a
  GitPython `BadName` issue.  ([#2712]), ([#2794])
- The progess bar for annex file transferring was unable to handle an
  empty file.  ([#2717])
- `datalad add-readme` halted when no aggregated metadata was found
  rather than displaying a warning.  ([#2731])
- `datalad rerun` failed if `--onto` was specified and the history
  contained no run commits.  ([#2761])
- Processing of a command's results failed on a result record with a
  missing value (e.g., absent field or subfield in metadata).  Now the
  missing value is rendered as "N/A".  ([#2725]).
- A couple of documentation links in the "Delineation from related
  solutions" were misformatted.  ([#2773])
- With the latest git-annex, several known V6 failures are no longer
  an issue.  ([#2777])
- In direct mode, commit changes would often commit annexed content as
  regular Git files.  A new approach fixes this and resolves a good
  number of known failures.  ([#2770])
- The reporting of command results failed if the current working
  directory was removed (e.g., after an unsuccessful `install`). ([#2788])
- When installing into an existing empty directory, `datalad install`
  removed the directory after a failed clone.  ([#2788])
- `datalad run` incorrectly handled inputs and outputs for paths with
  spaces and other characters that require shell escaping.  ([#2798])
- Globbing inputs and outputs for `datalad run` didn't work correctly
  if a subdataset wasn't installed.  ([#2796])
- Minor (in)compatibility with git 2.19 - (no) trailing period
  in an error message now. ([#2815])

Enhancements and new features

- Anonymous access is now supported for S3 and other downloaders.  ([#2708])
- A new interface is available to ease setting up new providers.  ([#2708])
- Metadata: changes to egrep mode search  ([#2735])
  - Queries in egrep mode are now case-sensitive when the query
    contains any uppercase letters and are case-insensitive otherwise.
    The new mode egrepcs can be used to perform a case-sensitive query
    with all lower-case letters.
  - Search can now be limited to a specific key.
  - Multiple queries (list of expressions) are evaluated using AND to
    determine whether something is a hit.
  - A single multi-field query (e.g., `pa*:findme`) is a hit, when any
    matching field matches the query.
  - All matching key/value combinations across all (multi-field)
    queries are reported in the query_matched result field.
  - egrep mode now shows all hits rather than limiting the results to
    the top 20 hits.
- The documentation on how to format commands for `datalad run` has
  been improved.  ([#2703])
- The method for determining the current working directory on Windows
  has been improved.  ([#2707])
- `datalad --version` now simply shows the version without the
  license.  ([#2733])
- `datalad export-archive` learned to export under an existing
  directory via its `--filename` option.  ([#2723])
- `datalad export-to-figshare` now generates the zip archive in the
  root of the dataset unless `--filename` is specified.  ([#2723])
- After importing `datalad.api`, `help(datalad.api)` (or
  `datalad.api?` in IPython) now shows a summary of the available
  DataLad commands.  ([#2728])
- Support for using `datalad` from IPython has been improved.  ([#2722])
- `datalad wtf` now returns structured data and reports the version of
  each extension.  ([#2741])
- The internal handling of gitattributes information has been
  improved.  A user-visible consequence is that `datalad create
  --force` no longer duplicates existing attributes.  ([#2744])
- The "annex" metadata extractor can now be used even when no content
  is present.  ([#2724])
- The `add_url_to_file` method (called by commands like `datalad
  download-url` and `datalad add-archive-content`) learned how to
  display a progress bar.  ([#2738])

* tag '0.10.3': (214 commits)
  Changelog entry for 2.19 git compat fix
  DOC: slight tune ups to the ChangeLog
  ENH: link issue/pull #s in CHANGELOG, use tools/link_issues_CHANGELOG
  BF: remove trailing period while matching a mesage from git
  DOC: try_multiple_dec: Add description of `duration` parameter
  CLN: annexrepo: Fix grammar in a recently added comment
  TST: auto: Reformat comment from 900ee08
  DOC: _rmtree: Drop a word from summary line
  DOC: Info on IDs (fixes gh-2801)
  BF: diff -- when reraising - just raise, do not raise that instance of exception from new location
  BF(TST): precommit before removing submodule so there is no batched processes
  ENH+BF(TST): close established ssh sockets upon test finish
  BF(TST): One more "clost all log handlers in the test"
  CHANGELOG.md: Start adding entries for v0.10.3
  BF(TST): close cookies db in the teardown since atexit is later, so cannot assure no open files
  BF(TST): explicitly close created log handlers
  ENH(TST): @known_failure_windows to replace plain @skip_if_on_windows where there is hope
  BF(TST): do not swallow output while testing AutomagicIO to not cause some open files issue
  ENH(TST): Skip a test when cannot remove curent directory
  BF(TST): explicitly precommit a repo used under swallow_outputs
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment