issues

Table actions

2 rows where "closed_at" is on date 2021-04-11, repo = 13221727 and user = 226037 sorted by updated_at descending

✎ View and edit SQL

This data as json, CSV (advanced)

Suggested facets: created_at (date), updated_at (date), closed_at (date)

type 2

state 1

repo 1

  • xarray · 2 ✖
id node_id number title user state locked assignee milestone comments created_at updated_at ▲ closed_at author_association active_lock_reason draft pull_request body reactions performed_via_github_app state_reason repo type
852256995 MDU6SXNzdWU4NTIyNTY5OTU= 5125 Add `BackendEntrypoint` to an easier to find location alexamici 226037 closed 0     3 2021-04-07T10:21:16Z 2021-04-11T18:53:03Z 2021-04-11T18:53:03Z MEMBER      

Is your feature request related to a problem? Please describe.

I started implementing a few backend plugins following the documentation so I noticed a few easily fixable quirks:

http://xarray.pydata.org/en/latest/internals/how-to-add-new-backend.html

The main one is the BackendEntrypoint is found deep into xarray.backends.common.

Describe the solution you'd like

I suggest to add an easier to find reference: * xarray.backends.BackendEntrypoint would do * but maybe even xarray.BackendEntrypoint.

Additional context

For the simplest plugins BackendEntrypoint would be the only import to connect to xarray.

See this dummy GDAL plugin: https://github.com/bopen/xarray-gdal/blob/main/xarray_gdal/xarray_plugin.py But also the rioxarray plugin in this PR: corteva/rioxarray/pull/281

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/5125/reactions",
    "total_count": 1,
    "+1": 1,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   completed xarray 13221727 issue
852296907 MDExOlB1bGxSZXF1ZXN0NjEwNTc0MDg5 5127 Simplify the user experience of a backend developer (imports and docs) alexamici 226037 closed 0     0 2021-04-07T11:11:58Z 2021-04-11T18:50:06Z 2021-04-11T18:50:06Z MEMBER   0 pydata/xarray/pulls/5127
  • [x] Proposed fix for #5125
  • [x] No need to add tests
  • [x] Passes pre-commit run --all-files
  • [x] Documentation is synced

This is mostly a stylistic revamp of the documentation on "How to add a new backend" after I followed the process a couple of times: * add import statments * use always my_*/My (there where some your_) * avoid ellipsis

The main code change is adding references to BackendEntrypoint and BackendArray in xarray.backends.

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/5127/reactions",
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     xarray 13221727 pull

Advanced export

JSON shape: default, array, newline-delimited, object

CSV options: 

CREATE TABLE [issues] (
   [id] INTEGER PRIMARY KEY,
   [node_id] TEXT,
   [number] INTEGER,
   [title] TEXT,
   [user] INTEGER REFERENCES [users]([id]),
   [state] TEXT,
   [locked] INTEGER,
   [assignee] INTEGER REFERENCES [users]([id]),
   [milestone] INTEGER REFERENCES [milestones]([id]),
   [comments] INTEGER,
   [created_at] TEXT,
   [updated_at] TEXT,
   [closed_at] TEXT,
   [author_association] TEXT,
   [active_lock_reason] TEXT,
   [draft] INTEGER,
   [pull_request] TEXT,
   [body] TEXT,
   [reactions] TEXT,
   [performed_via_github_app] TEXT,
   [state_reason] TEXT,
   [repo] INTEGER REFERENCES [repos]([id]),
   [type] TEXT
);
CREATE INDEX [idx_issues_repo]
    ON [issues] ([repo]);
CREATE INDEX [idx_issues_milestone]
    ON [issues] ([milestone]);
CREATE INDEX [idx_issues_assignee]
    ON [issues] ([assignee]);
CREATE INDEX [idx_issues_user]
    ON [issues] ([user]);