Task #3658 (closed)
Method naming: get vv list vv lookup
Reported by: | wmoore | Owned by: | atarkowska |
---|---|---|---|
Priority: | major | Milestone: | OMERO-Beta4.3 |
Component: | OmeroPy | Version: | n.a. |
Keywords: | n.a. | Cc: | cneves, jburel |
Resources: | n.a. | Referenced By: | n.a. |
References: | n.a. | Remaining Time: | 0.0d |
Sprint: | 2011-01-27 (4) |
Description (last modified by wmoore)
Need to decide on this as part of webclient_gateway.py merge with omero.gateway.
Mixture of method names. lookup vv get vv list. Need a common strategy? E.g.
- getImage(ID) or getImages(IDs)
- listImages() # all - maybe select by owner etc.
- lookupImages(name)
- getSpecifiedImages(IDs)
Problem is compounded by the underlying API.
Change History (15)
comment:1 Changed 13 years ago by wmoore
- Cc jburel added
comment:2 Changed 13 years ago by atarkowska
- Remaining Time set to 2
- Sprint set to 2011-01-13 (23)
- Status changed from new to assigned
comment:3 Changed 13 years ago by atarkowska
comment:4 Changed 13 years ago by wmoore
- Description modified (diff)
comment:5 Changed 13 years ago by atarkowska
(In [8887/omero]) minor bug fixing related to r8878, see #3658
comment:6 Changed 13 years ago by atarkowska
http://www.python.org/dev/peps/pep-0008/
Codding style:
- Use 4 spaces per indentation level.
- Limit all lines to a maximum of 79 characters.
- Imports should usually be on separate lines
- Imports are always put at the top of the file, just after any module comments and docstrings, and before module globals and constants.
Naming convention:
- Boolean:
- isAttribute()
- Return object/-s
- getObject(id)
- getObjects(ids)
- lookupObject(attr)
- lookupObjects(attr)
- getObjectByAttribute(attr)
- getObjectsByAttribute(attr)
- listObjects()
- Timeline:
- getMostRecentObjects()
- Loading:
- loadObject(parent)
- Combined:
- getCombinedattributes(id)
- lookupCombinedattributes(attr)
- Return only attribute/-s:
- getChildAttribute(parentId), getParentAttribute(childId)
- getChildAttributes(parentId), getParentAttributes(childId)
- lookupChildAttributes(parentAttr), lookupParentAttributes(childAttr)
- listChildAttributes(), listParentAttributes()
comment:7 Changed 13 years ago by jburel
- Sprint changed from 2011-01-13 (23) to 2011-01-27 (24)
Moved from sprint 2011-01-13 (23)
comment:8 Changed 13 years ago by atarkowska
(In [8911/omero]) this refractor the way of loading parent/child links, see #3650, see #3658
comment:9 Changed 13 years ago by atarkowska
(In [8919/omero]) this refractor the way of loading annotation parent/child links, adds getAnnotations and listAnnotations, see #3650, see #3658
comment:10 Changed 13 years ago by Aleksandra Tarkowska <aleksandrat@…>
- Remaining Time changed from 2 to 0
- Resolution set to fixed
- Status changed from assigned to closed
(In [e4534d37711d3d8c24fa09666781d859e750ce69/ome.git]) This changeset finalize omero.gateway and webclient_gateway refactoring (fix #3650 and #3804 and #3658)
comment:11 Changed 13 years ago by Carlos Neves <carlos@…>
(In [ae9c55a4e11be439f76e504b3a9cd08cbb3941b6/ome.git] on branch dev_4_1_custom) this refractor the way of loading annotation parent/child links, adds getAnnotations and listAnnotations, see #3650, see #3658
git-svn-id: file:///home/svn/omero/trunk@8919 05709c45-44f0-0310-885b-81a1db45b4a6
comment:12 Changed 13 years ago by Carlos Neves <carlos@…>
(In [7aab64f683f06581de7b735c21c2ef785474848b/ome.git] on branch dev_4_1_custom) This changeset finalize omero.gateway and webclient_gateway refactoring (fix #3650 and #3804 and #3658)
comment:13 Changed 13 years ago by Carlos Neves <carlos@…>
(In [ae9c55a4e11be439f76e504b3a9cd08cbb3941b6/ome.git]on branches 4_1_custom, dev_4_1_custom, josh/4.1-web-backport) this refractor the way of loading annotation parent/child links, adds getAnnotations and listAnnotations, see #3650, see #3658
git-svn-id: file:///home/svn/omero/trunk@8919 05709c45-44f0-0310-885b-81a1db45b4a6
comment:14 Changed 13 years ago by Carlos Neves <carlos@…>
(In [7aab64f683f06581de7b735c21c2ef785474848b/ome.git]on branches 4_1_custom, dev_4_1_custom, josh/4.1-web-backport) This changeset finalize omero.gateway and webclient_gateway refactoring (fix #3650 and #3804 and #3658)
comment:15 Changed 13 years ago by Aleksandra Tarkowska <aleksandrat@…>
(In [e4534d37711d3d8c24fa09666781d859e750ce69/ome.git]on branches master, develop, feature/5252-import-cancel, fix/4463, python-gateway) This changeset finalize omero.gateway and webclient_gateway refactoring (fix #3650 and #3804 and #3658)
(In [8878/omero]) source code re-factoring, see #3658 and small query issue in getTagsByObject