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

ENH: report absent fields reported as N/A in output instead of not rendering the record at all #2725

merged 2 commits into from Aug 15, 2018


Copy link

@yarikoptic yarikoptic commented Aug 1, 2018

Since this one might controversial and still needs tests, filing it separately from #2724:

  • If result record is missing a value (absent field, or subfield in metadata), do not crash rendering it, but just print N/A for that value. I wonder though if there should be config option to turn that behavior off since might be handy to see original crash at times

  • at least a basic test for the functionality

  • shortened access syntax item moved the other into a separate issue #2760

@yarikoptic yarikoptic force-pushed the enh-format-output branch from ce5b5ed to e9de142 Aug 1, 2018
Copy link

@codecov codecov bot commented Aug 1, 2018

Codecov Report

Merging #2725 into master will decrease coverage by 0.03%.
The diff coverage is 95%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2725      +/-   ##
- Coverage   90.42%   90.39%   -0.04%     
  Files         245      245              
  Lines       30918    31266     +348     
+ Hits        27959    28262     +303     
- Misses       2959     3004      +45
Impacted Files Coverage Δ
datalad/interface/tests/ 100% <100%> (ø) ⬆️
datalad/interface/ 90.03% <93.75%> (-5.13%) ⬇️
datalad/plugin/ 79.89% <0%> (-10.27%) ⬇️
datalad/ui/ 97.72% <0%> (-2.28%) ⬇️
datalad/ui/ 89.69% <0%> (-2.17%) ⬇️
datalad/ 93.1% <0%> (-1.64%) ⬇️
datalad/plugin/ 78.72% <0%> (-0.87%) ⬇️
datalad/interface/ 94.26% <0%> (-0.41%) ⬇️
datalad/plugin/ 20.14% <0%> (-0.3%) ⬇️
... and 18 more

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 cce8cf5...4969148. Read the comment docs.

@yarikoptic yarikoptic added this to the Release 0.10.3 milestone Aug 2, 2018
Copy link
Member Author

@yarikoptic yarikoptic commented Aug 8, 2018

@mih so what do you think? or should we come up with a bit extended support for that? I was thinking about making dedicated output format modes, so we have format and may be format-NA with a dedicated new option field (-F?) so I could say -f format -F '{...}' to allow for current case where it just fails to render if a field is missing a value.

Copy link

@mih mih commented Aug 8, 2018

Let's talk about a few more general aspects first.

Copy link
Member Author

@yarikoptic yarikoptic commented Aug 8, 2018

That means to merge this one or to drop it?

Copy link
Member Author

@yarikoptic yarikoptic commented Aug 9, 2018

ok, will add a test or two and if no objects would vote to merge it without overthinking some "general aspects"

Copy link
Member Author

@yarikoptic yarikoptic commented Aug 14, 2018

If no strong objections are expressed, I will merge it tomorrow - I am loosing control over all PRs staged across a variety of projects etc

@yarikoptic yarikoptic merged commit 7a3ead7 into datalad:master Aug 15, 2018
9 checks passed
yarikoptic added a commit that referenced this issue Sep 13, 2018
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.


- 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" 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
@yarikoptic yarikoptic deleted the enh-format-output branch Feb 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants