|
| 1 | +# Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 2 | +# not use this file except in compliance with the License. You may obtain |
| 3 | +# a copy of the License at |
| 4 | +# |
| 5 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | +# |
| 7 | +# Unless required by applicable law or agreed to in writing, software |
| 8 | +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 9 | +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 10 | +# License for the specific language governing permissions and limitations |
| 11 | +# under the License. |
| 12 | + |
| 13 | +from osc_lib.cli import parseractions |
| 14 | + |
| 15 | +from openstackclient.i18n import _ |
| 16 | + |
| 17 | + |
| 18 | +# TODO(stephenfin): Consider moving these to osc-lib since they're broadly |
| 19 | +# useful |
| 20 | + |
| 21 | + |
| 22 | +def add_marker_pagination_option_to_parser(parser): |
| 23 | + """Add marker-based pagination options to the parser. |
| 24 | +
|
| 25 | + APIs that use marker-based paging use the marker and limit query parameters |
| 26 | + to paginate through items in a collection. |
| 27 | +
|
| 28 | + Marker-based pagination is often used in cases where the length of the |
| 29 | + total set of items is either changing frequently, or where the total length |
| 30 | + might not be known upfront. |
| 31 | + """ |
| 32 | + parser.add_argument( |
| 33 | + '--limit', |
| 34 | + metavar='<limit>', |
| 35 | + type=int, |
| 36 | + action=parseractions.NonNegativeAction, |
| 37 | + help=_( |
| 38 | + 'The maximum number of entries to return. If the value exceeds ' |
| 39 | + 'the server-defined maximum, then the maximum value will be used.' |
| 40 | + ), |
| 41 | + ) |
| 42 | + parser.add_argument( |
| 43 | + '--marker', |
| 44 | + metavar='<marker>', |
| 45 | + default=None, |
| 46 | + help=_( |
| 47 | + 'The first position in the collection to return results from. ' |
| 48 | + 'This should be a value that was returned in a previous request.' |
| 49 | + ), |
| 50 | + ) |
| 51 | + |
| 52 | + |
| 53 | +def add_offset_pagination_option_to_parser(parser): |
| 54 | + """Add offset-based pagination options to the parser. |
| 55 | +
|
| 56 | + APIs that use offset-based paging use the offset and limit query parameters |
| 57 | + to paginate through items in a collection. |
| 58 | +
|
| 59 | + Offset-based pagination is often used where the list of items is of a fixed |
| 60 | + and predetermined length. |
| 61 | + """ |
| 62 | + parser.add_argument( |
| 63 | + '--limit', |
| 64 | + metavar='<limit>', |
| 65 | + type=int, |
| 66 | + action=parseractions.NonNegativeAction, |
| 67 | + help=_( |
| 68 | + 'The maximum number of entries to return. If the value exceeds ' |
| 69 | + 'the server-defined maximum, then the maximum value will be used.' |
| 70 | + ), |
| 71 | + ) |
| 72 | + parser.add_argument( |
| 73 | + '--offset', |
| 74 | + metavar='<offset>', |
| 75 | + type=int, |
| 76 | + action=parseractions.NonNegativeAction, |
| 77 | + default=None, |
| 78 | + help=_( |
| 79 | + 'The (zero-based) offset of the first item in the collection to ' |
| 80 | + 'return.' |
| 81 | + ), |
| 82 | + ) |
0 commit comments