Exemple #1
0
    def __init__(self):
        ResourceUri.__init__(
            self, output_type_serializer=api.EquipmentReportsSerializer)
        ResourceUtc.__init__(self)
        parser_get = self.parsers["get"]
        parser_get.add_argument("depth",
                                type=DepthArgument(),
                                default=1,
                                help="The depth of your object")
        parser_get.add_argument("count",
                                type=default_count_arg_type,
                                default=25,
                                help="Number of objects per page")
        parser_get.add_argument("filter",
                                type=six.text_type,
                                default="",
                                help="Filter your objects")
        parser_get.add_argument("start_page",
                                type=int,
                                default=0,
                                help="The current page")
        parser_get.add_argument(
            "forbidden_uris[]",
            type=six.text_type,
            help="forbidden uris",
            dest="forbidden_uris[]",
            default=[],
            action="append",
            schema_metadata={'format': 'pt-object'},
        )

        self.collection = 'equipment_reports'
        self.get_decorators.insert(0, ManageError())
        self.get_decorators.insert(1, get_obj_serializer(self))
Exemple #2
0
    def __init__(self, endpoint, *args, **kwargs):
        ResourceUri.__init__(self, *args, **kwargs)
        ResourceUtc.__init__(self)
        self.endpoint = endpoint
        self.parsers["get"] = reqparse.RequestParser(argument_class=ArgumentDoc)
        parser_get = self.parsers["get"]
        parser_get.add_argument("filter", type=six.text_type)
        parser_get.add_argument("from_datetime", type=DateTimeFormat(), default=None,
                                help="The datetime from which you want the schedules")
        parser_get.add_argument("until_datetime", type=DateTimeFormat(), default=None,
                                help="The datetime until which you want the schedules")
        parser_get.add_argument("duration", type=int, default=3600 * 24,
                                help="Maximum duration between datetime and the retrieved stop time")
        parser_get.add_argument("depth", type=depth_argument, default=2)
        parser_get.add_argument("count", type=default_count_arg_type, default=10,
                                help="Number of schedules per page")
        parser_get.add_argument("start_page", type=int, default=0,
                                help="The current page")
        parser_get.add_argument("max_date_times", type=UnsignedInteger(), deprecated=True,
                                help="DEPRECATED, replaced by `items_per_schedule`")
        parser_get.add_argument("forbidden_id[]", type=six.text_type, deprecated=True,
                                help="DEPRECATED, replaced by `forbidden_uris[]`",
                                dest="__temporary_forbidden_id[]",
                                default=[],
                                action='append',
                                schema_metadata={'format': 'pt-object'})
        parser_get.add_argument("forbidden_uris[]", type=six.text_type,
                                help="forbidden uris",
                                dest="forbidden_uris[]",
                                default=[],
                                action='append',
                                schema_metadata={'format': 'pt-object'})
        parser_get.add_argument("calendar", type=six.text_type,
                                help="Id of the calendar")
        parser_get.add_argument("distance", type=int, default=200,
                                help="Distance range of the query. Used only if a coord is in the query")
        parser_get.add_argument("show_codes", type=BooleanType(), default=False,
                                help="show more identification codes")
        #Note: no default param for data freshness, the default depends on the API
        parser_get.add_argument("data_freshness",
                                help='freshness of the data. '
                                     'base_schedule is the long term planned schedule. '
                                     'adapted_schedule is for planned ahead disruptions (strikes, '
                                     'maintenances, ...). '
                                     'realtime is to have the freshest possible data',
                                type=OptionValue(['base_schedule', 'adapted_schedule', 'realtime']))
        parser_get.add_argument("_current_datetime", type=DateTimeFormat(),
                                schema_metadata={'default': 'now'}, hidden=True,
                                default=datetime.utcnow(),
                                help='The datetime considered as "now". Used for debug, default is '
                                     'the moment of the request. It will mainly change the output '
                                     'of the disruptions.')
        parser_get.add_argument("items_per_schedule", type=UnsignedInteger(), default=10000,
                                help="maximum number of date_times per schedule")
        parser_get.add_argument("disable_geojson", type=BooleanType(), default=False,
                                help="remove geojson from the response")

        self.get_decorators.insert(0, ManageError())
        self.get_decorators.insert(1, get_obj_serializer(self))
        self.get_decorators.append(complete_links(self))
Exemple #3
0
    def __init__(self):
        ResourceUri.__init__(self, output_type_serializer=api.LineReportsSerializer)
        ResourceUtc.__init__(self)
        parser_get = self.parsers["get"]
        parser_get.add_argument("depth", type=int, default=1, help="The depth of your object")
        parser_get.add_argument("count", type=default_count_arg_type, default=25,
                                help="Number of objects per page")
        parser_get.add_argument("start_page", type=int, default=0,
                                help="The current page")
        parser_get.add_argument("_current_datetime", type=DateTimeFormat(),
                                schema_metadata={'default': 'now'}, hidden=True,
                                default=datetime.utcnow(),
                                help='The datetime considered as "now". Used for debug, default is '
                                     'the moment of the request. It will mainly change the output '
                                     'of the disruptions.')
        parser_get.add_argument("forbidden_uris[]", type=six.text_type,
                                help="forbidden uris",
                                dest="forbidden_uris[]",
                                default=[],
                                action="append",
                                schema_metadata={'format': 'pt-object'})
        parser_get.add_argument("disable_geojson", type=BooleanType(), default=False,
                                help="remove geojson from the response")
        parser_get.add_argument("since", type=DateTimeFormat(),
                                help="use disruptions valid after this date")
        parser_get.add_argument("until", type=DateTimeFormat(),
                                help="use disruptions valid before this date")

        self.collection = 'line_reports'
        self.collections = line_reports
        self.get_decorators.insert(0, ManageError())
        self.get_decorators.insert(1, get_obj_serializer(self))
Exemple #4
0
    def __init__(self, endpoint):
        ResourceUri.__init__(self)
        ResourceUtc.__init__(self)
        self.endpoint = endpoint
        self.parsers = {}
        self.parsers["get"] = reqparse.RequestParser(argument_class=ArgumentDoc)
        parser_get = self.parsers["get"]
        parser_get.add_argument("filter", type=six.text_type)
        parser_get.add_argument("from_datetime", type=DateTimeFormat(), default=None,
                                help="The datetime from which you want the schedules")
        parser_get.add_argument("until_datetime", type=DateTimeFormat(), default=None,
                                help="The datetime until which you want the schedules")
        parser_get.add_argument("duration", type=int, default=3600 * 24,
                                help="Maximum duration between datetime and the retrieved stop time")
        parser_get.add_argument("depth", type=int, default=2)
        parser_get.add_argument("count", type=default_count_arg_type, default=10,
                                help="Number of schedules per page")
        parser_get.add_argument("start_page", type=int, default=0,
                                help="The current page")
        parser_get.add_argument("max_date_times", type=natural,
                                help="DEPRECATED, replaced by `items_per_schedule`")
        parser_get.add_argument("forbidden_id[]", type=six.text_type,
                                help="DEPRECATED, replaced by `forbidden_uris[]`",
                                dest="__temporary_forbidden_id[]",
                                default=[],
                                action='append')
        parser_get.add_argument("forbidden_uris[]", type=six.text_type,
                                help="forbidden uris",
                                dest="forbidden_uris[]",
                                default=[],
                                action='append')

        parser_get.add_argument("calendar", type=six.text_type,
                                help="Id of the calendar")
        parser_get.add_argument("distance", type=int, default=200,
                                help="Distance range of the query. Used only if a coord is in the query")
        parser_get.add_argument("show_codes", type=BooleanType(), default=False,
                                help="show more identification codes")
        #Note: no default param for data freshness, the default depends on the API
        parser_get.add_argument("data_freshness",
                                help='freshness of the data. '
                                     'base_schedule is the long term planned schedule. '
                                     'adapted_schedule is for planned ahead disruptions (strikes, '
                                     'maintenances, ...). '
                                     'realtime is to have the freshest possible data',
                                type=OptionValue(['base_schedule', 'adapted_schedule', 'realtime']))
        parser_get.add_argument("_current_datetime", type=DateTimeFormat(), default=datetime.datetime.utcnow(),
                                help="The datetime we want to publish the disruptions from."
                                     " Default is the current date and it is mainly used for debug.")
        parser_get.add_argument("items_per_schedule", type=natural, default=10000,
                                help="maximum number of date_times per schedule")
        parser_get.add_argument("disable_geojson", type=BooleanType(), default=False,
                                help="remove geojson from the response")

        self.get_decorators.append(complete_links(self))
Exemple #5
0
    def __init__(self):
        ResourceUri.__init__(
            self, output_type_serializer=api.VehiclePositionsSerializer)
        ResourceUtc.__init__(self)
        parser_get = self.parsers["get"]
        parser_get.add_argument("depth",
                                type=DepthArgument(),
                                default=1,
                                help="The depth of your object")
        parser_get.add_argument("count",
                                type=default_count_arg_type,
                                default=25,
                                help="Number of objects per page")
        parser_get.add_argument("filter",
                                type=six.text_type,
                                default="",
                                help="Filter your objects")
        parser_get.add_argument("start_page",
                                type=int,
                                default=0,
                                help="The current page")
        parser_get.add_argument(
            "forbidden_uris[]",
            type=six.text_type,
            help="forbidden uris",
            dest="forbidden_uris[]",
            default=[],
            action="append",
            schema_metadata={'format': 'pt-object'},
        )
        parser_get.add_argument(
            "_current_datetime",
            type=DateTimeFormat(),
            schema_metadata={'default': 'now'},
            hidden=True,
            default=datetime.utcnow(),
            help='The datetime considered as "now". Used for debug, default is '
            'the moment of the request. It will mainly change the output '
            'of the disruptions.',
        )

        self.collection = 'vehicle_positions'
        self.get_decorators.insert(0, ManageError())
        self.get_decorators.insert(1, get_obj_serializer(self))
Exemple #6
0
    def __init__(self, output_type_serializer):
        ResourceUri.__init__(self,
                             authentication=False,
                             output_type_serializer=output_type_serializer)
        ResourceUtc.__init__(self)

        types = {
            "all": "All types",
            "best": "The best journey",
            "rapid":
            "A good trade off between duration, changes and constraint respect",
            'no_train': "Journey without train",
            'comfort': "A journey with less changes and walking",
            'car': "A journey with car to get to the public transport",
            'less_fallback_walk': "A journey with less walking",
            'less_fallback_bike': "A journey with less biking",
            'less_fallback_bss': "A journey with less bss",
            'fastest': "A journey with minimum duration",
            'non_pt_walk': "A journey without public transport, only walking",
            'non_pt_bike': "A journey without public transport, only biking",
            'non_pt_bss':
            "A journey without public transport, only bike sharing",
        }
        data_freshnesses = {
            'base_schedule':
            'Use theoric schedule information',
            'realtime':
            'Use all realtime information',
            'adapted_schedule':
            'Use of adapted schedule information (like strike adjusting, etc.). '
            'Prefer `realtime` for traveler information as it will also contain '
            'adapted information schedule.',
        }
        parser_get = self.parsers["get"]

        parser_get.add_argument(
            "from",
            type=six.text_type,
            dest="origin",
            help='The id of the departure of your journey. '
            'If not provided an isochrone is computed.',
            schema_metadata={'format': 'place'},
        )
        parser_get.add_argument(
            "to",
            type=six.text_type,
            dest="destination",
            help='The id of the arrival of your journey. '
            'If not provided an isochrone is computed.',
            schema_metadata={'format': 'place'},
        )
        parser_get.add_argument(
            "datetime",
            type=DateTimeFormat(),
            help='Date and time to go/arrive (see `datetime_represents`).\n'
            'Note: the datetime must be in the coverage’s publication period.',
        )
        parser_get.add_argument(
            "datetime_represents",
            dest="clockwise",
            type=DatetimeRepresents(),
            default=True,
            help="Determine how datetime is handled.\n\n"
            "Possible values:\n"
            " * 'departure' - Compute journeys starting after datetime\n"
            " * 'arrival' - Compute journeys arriving before datetime",
        )
        parser_get.add_argument("max_transfers",
                                type=int,
                                default=42,
                                hidden=True,
                                deprecated=True)
        parser_get.add_argument(
            "max_nb_transfers",
            type=int,
            dest="max_transfers",
            help='Maximum number of transfers in each journey',
        )
        parser_get.add_argument(
            "min_nb_transfers",
            type=int,
            default=0,
            help='Minimum number of transfers in each journey')
        parser_get.add_argument(
            "first_section_mode[]",
            type=OptionValue(fallback_modes.all_fallback_modes),
            dest="origin_mode",
            action="append",
            help='Force the first section mode '
            'if the first section is not a public transport one.\n'
            '`bss` stands for bike sharing system.\n'
            'Note 1: It’s an array, you can give multiple modes.\n'
            'Note 2: Choosing `bss` implicitly allows the walking mode since '
            'you might have to walk to the bss station.\n'
            'Note 3: The parameter is inclusive, not exclusive, '
            'so if you want to forbid a mode, you need to add all the other modes. '
            'Eg: If you never want to use a car, you need: '
            '`first_section_mode[]=walking&first_section_mode[]=bss&'
            'first_section_mode[]=bike&last_section_mode[]=walking&'
            'last_section_mode[]=bss&last_section_mode[]=bike`',
        )
        parser_get.add_argument(
            "last_section_mode[]",
            type=OptionValue(fallback_modes.all_fallback_modes),
            dest="destination_mode",
            action="append",
            help='Same as first_section_mode but for the last section.',
        )
        # for retrocompatibility purpose, we duplicate (without []):
        parser_get.add_argument(
            "first_section_mode",
            hidden=True,
            deprecated=True,
            type=OptionValue(fallback_modes.all_fallback_modes),
            action="append",
        )
        parser_get.add_argument(
            "last_section_mode",
            hidden=True,
            deprecated=True,
            type=OptionValue(fallback_modes.all_fallback_modes),
            action="append",
        )

        parser_get.add_argument(
            "max_duration_to_pt",
            type=int,
            help=
            "Maximum allowed duration to reach the public transport (same limit used before and "
            "after public transport).\n"
            "Use this to limit the walking/biking part.\n"
            "Unit is seconds",
        )
        parser_get.add_argument(
            "max_walking_duration_to_pt",
            type=int,
            help="Maximal duration of walking on public transport in second",
        )
        parser_get.add_argument(
            "max_bike_duration_to_pt",
            type=int,
            help="Maximal duration of bike on public transport in second")
        parser_get.add_argument(
            "max_bss_duration_to_pt",
            type=int,
            help="Maximal duration of bss on public transport in second")
        parser_get.add_argument(
            "max_car_duration_to_pt",
            type=int,
            help="Maximal duration of car on public transport in second")
        parser_get.add_argument(
            "max_ridesharing_duration_to_pt",
            type=int,
            dest="max_car_no_park_duration_to_pt",
            help=
            "Maximal duration of ridesharing on public transport in second",
        )
        parser_get.add_argument(
            "walking_speed",
            type=PositiveFloat(),
            help='Walking speed for the fallback sections.\n'
            'Speed unit must be in meter/second',
        )
        parser_get.add_argument(
            "bike_speed",
            type=PositiveFloat(),
            help='Biking speed for the fallback sections.\n'
            'Speed unit must be in meter/second',
        )
        parser_get.add_argument(
            "bss_speed",
            type=PositiveFloat(),
            help='Speed while using a bike from a bike sharing system for the '
            'fallback sections.\n'
            'Speed unit must be in meter/second',
        )
        parser_get.add_argument(
            "car_speed",
            type=PositiveFloat(),
            help='Driving speed for the fallback sections.\n'
            'Speed unit must be in meter/second',
        )
        parser_get.add_argument(
            "ridesharing_speed",
            type=PositiveFloat(),
            dest="car_no_park_speed",
            help='ridesharing speed for the fallback sections.\n'
            'Speed unit must be in meter/second',
        )
        parser_get.add_argument(
            "taxi_speed",
            type=PositiveFloat(),
            dest="taxi_speed",
            help='taxi speed speed for the fallback sections.\n'
            'Speed unit must be in meter/second',
        )
        parser_get.add_argument(
            "forbidden_uris[]",
            type=six.text_type,
            action="append",
            help='If you want to avoid lines, modes, networks, etc.\n'
            'Note: the forbidden_uris[] concern only the public transport objects. '
            'You can’t for example forbid the use of the bike with them, '
            'you have to set the fallback modes for this '
            '(first_section_mode[] and last_section_mode[])',
            schema_metadata={'format': 'pt-object'},
        )
        parser_get.add_argument(
            "allowed_id[]",
            type=six.text_type,
            action="append",
            help='If you want to use only a small subset of '
            'the public transport objects in your solution.\n'
            'Note: The constraint intersects with forbidden_uris[]. '
            'For example, if you ask for '
            '`allowed_id[]=line:A&forbidden_uris[]=physical_mode:Bus`, '
            'only vehicles of the line A that are not buses will be used.',
            schema_metadata={'format': 'pt-object'},
        )
        parser_get.add_argument(
            "type",
            type=DescribedOptionValue(types),
            default="all",
            deprecated=True,
            help='DEPRECATED, desired type of journey.',
            hidden=True,
        )
        parser_get.add_argument(
            "disruption_active",
            type=BooleanType(),
            default=False,
            deprecated=True,
            help='DEPRECATED, replaced by `data_freshness`.\n'
            'If true the algorithm takes the disruptions into account, '
            'and thus avoid disrupted public transport.\n'
            'Nota: `disruption_active=true` <=> `data_freshness=realtime`',
        )
        # no default value for data_freshness because we need to maintain retrocomp with disruption_active
        parser_get.add_argument(
            "data_freshness",
            type=DescribedOptionValue(data_freshnesses),
            help="Define the freshness of data to use to compute journeys.\n"
            "When using the following parameter `&data_freshness=base_schedule` "
            "you can get disrupted journeys in the response. "
            "You can then display the disruption message to the traveler and "
            "make a `realtime` request to get a new undisrupted solution.",
        )
        parser_get.add_argument(
            "max_duration",
            type=UnsignedInteger(),
            help=
            'Maximum duration of journeys in seconds (from `datetime` parameter).\n'
            'More usefull when computing an isochrone (only `from` or `to` is provided).\n'
            'On a classic journey (from-to), it will mostly speedup Navitia: You may have journeys a bit '
            'longer than that value (you would have to filter them).',
        )
        parser_get.add_argument(
            "wheelchair",
            type=BooleanType(),
            default=None,
            help='If true the traveler is considered to be using a wheelchair, '
            'thus only accessible public transport are used.\n'
            'Be warned: many data are currently too faint to provide '
            'acceptable answers with this parameter on.',
        )
        parser_get.add_argument(
            "traveler_type",
            type=OptionValue(acceptable_traveler_types),
            help=
            'Define speeds and accessibility values for different kind of people.\n'
            'Each profile also automatically determines appropriate first and '
            'last section modes to the covered area.\n'
            'Note: this means that you might get car, bike, etc. fallback routes '
            'even if you set `forbidden_uris[]`!\n'
            'You can overload all parameters '
            '(especially speeds, distances, first and last modes) by setting '
            'all of them specifically.\n'
            'We advise that you don’t rely on the traveler_type’s fallback modes '
            '(`first_section_mode[]` and `last_section_mode[]`) '
            'and set them yourself.',
        )
        parser_get.add_argument(
            "_current_datetime",
            type=DateTimeFormat(),
            schema_metadata={'default': 'now'},
            hidden=True,
            default=datetime.utcnow(),
            help='The datetime considered as "now". Used for debug, default is '
            'the moment of the request. It will mainly change the output '
            'of the disruptions.',
        )
        parser_get.add_argument(
            "direct_path",
            type=OptionValue(['indifferent', 'only', 'none']),
            default='indifferent',
            help="Specify if direct path should be suggested",
        )

        parser_get.add_argument(
            "free_radius_from",
            type=int,
            default=0,
            help="Radius length (in meters) around the coordinates of departure "
            "in which the stop points are considered free to go (crowfly=0)",
        )
        parser_get.add_argument(
            "free_radius_to",
            type=int,
            default=0,
            help="Radius length (in meters) around the coordinates of arrival "
            "in which the stop points are considered free to go (crowfly=0)",
        )
Exemple #7
0
    def __init__(self, is_collection, collection, *args, **kwargs):
        kwargs['authentication'] = False
        ResourceUri.__init__(self, *args, **kwargs)
        ResourceUtc.__init__(self)
        parser = self.parsers["get"]
        parser.add_argument("start_page",
                            type=int,
                            default=0,
                            help="The page where you want to start")
        parser.add_argument("count",
                            type=default_count_arg_type,
                            default=25,
                            help="Number of objects you want on a page")
        parser.add_argument("depth",
                            type=depth_argument,
                            schema_type=int,
                            default=1,
                            help="The depth of your object")
        parser.add_argument("forbidden_id[]",
                            type=six.text_type,
                            help="DEPRECATED, replaced by `forbidden_uris[]`",
                            dest="__temporary_forbidden_id[]",
                            default=[],
                            action="append",
                            schema_metadata={'format': 'pt-object'})
        parser.add_argument("forbidden_uris[]",
                            type=six.text_type,
                            help="forbidden uris",
                            dest="forbidden_uris[]",
                            default=[],
                            action="append",
                            schema_metadata={'format': 'pt-object'})
        # for the top level collection apis (/v1/networks, /v1/lines, ...) the external_code is mandatory
        external_code_mandatory = '.external_codes' in self.endpoint
        parser.add_argument("external_code",
                            type=six.text_type,
                            help="An external code to query",
                            required=external_code_mandatory)
        parser.add_argument("headsign",
                            type=six.text_type,
                            help="filter vehicle journeys on headsign")
        parser.add_argument("show_codes",
                            type=BooleanType(),
                            default=False,
                            help="show more identification codes")
        parser.add_argument("odt_level",
                            type=OptionValue(odt_levels),
                            default="all",
                            schema_type=str,
                            schema_metadata={"enum": odt_levels},
                            help="odt level")
        parser.add_argument(
            "_current_datetime",
            type=DateTimeFormat(),
            schema_metadata={'default': 'now'},
            hidden=True,
            default=datetime.utcnow(),
            help='The datetime considered as "now". Used for debug, default is '
            'the moment of the request. It will mainly change the output '
            'of the disruptions.')
        parser.add_argument(
            "distance",
            type=int,
            default=200,
            help=
            "Distance range of the query. Used only if a coord is in the query"
        )
        parser.add_argument("since",
                            type=DateTimeFormat(),
                            help="filters objects not valid before this date")
        parser.add_argument("until",
                            type=DateTimeFormat(),
                            help="filters objects not valid after this date")
        parser.add_argument("disable_geojson",
                            type=BooleanType(),
                            default=False,
                            help="remove geojson from the response")

        if is_collection:
            parser.add_argument("filter",
                                type=six.text_type,
                                default="",
                                help="The filter parameter")
        self.collection = collection
        self.get_decorators.insert(0, ManageError())
Exemple #8
0
    def __init__(self, is_collection, collection, *args, **kwargs):
        kwargs['authentication'] = False
        ResourceUri.__init__(self, *args, **kwargs)
        ResourceUtc.__init__(self)
        parser = self.parsers["get"]
        parser.add_argument("start_page",
                            type=int,
                            default=0,
                            help="The page where you want to start")
        parser.add_argument("count",
                            type=default_count_arg_type,
                            default=25,
                            help="Number of objects you want on a page")
        parser.add_argument("depth",
                            type=DepthArgument(),
                            schema_type=int,
                            default=1,
                            help="The depth of your object")
        parser.add_argument(
            "forbidden_id[]",
            type=six.text_type,
            help="DEPRECATED, replaced by `forbidden_uris[]`",
            dest="__temporary_forbidden_id[]",
            default=[],
            action="append",
            schema_metadata={'format': 'pt-object'},
        )
        parser.add_argument(
            "forbidden_uris[]",
            type=six.text_type,
            help="forbidden uris",
            dest="forbidden_uris[]",
            default=[],
            action="append",
            schema_metadata={'format': 'pt-object'},
        )
        # for the top level collection apis (/v1/networks, /v1/lines, ...) the external_code is mandatory
        external_code_mandatory = '.external_codes' in self.endpoint
        parser.add_argument(
            "external_code",
            type=six.text_type,
            help="An external code to query",
            required=external_code_mandatory,
        )
        parser.add_argument("headsign",
                            type=six.text_type,
                            help="filter vehicle journeys on headsign")
        parser.add_argument("show_codes",
                            type=BooleanType(),
                            default=False,
                            help="show more identification codes")
        parser.add_argument(
            "odt_level",
            type=OptionValue(odt_levels),
            default="all",
            schema_type=str,
            schema_metadata={"enum": odt_levels},
            help="odt level",
        )
        parser.add_argument(
            "_current_datetime",
            type=DateTimeFormat(),
            schema_metadata={'default': 'now'},
            hidden=True,
            default=datetime.now(),
            help='The datetime considered as "now". Used for debug, default is '
            'the moment of the request. It will mainly change the output '
            'of the disruptions.',
        )
        parser.add_argument(
            "data_freshness",
            help=
            "Define the freshness of data to use to filter vehicle_journeys "
            "along with parameters &since and/or &until .\n"
            "Provides only the vehicle_journeys valid for the data freshness level requested.\n"
            "Using `&data_freshness=base_schedule` will return all original vehicle_journeys only"
            "whereas using `&data_freshness=realtime` will return vehicle_journeys after applying"
            "modifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys).",
            type=OptionValue(['base_schedule', 'adapted_schedule',
                              'realtime']),
            default='base_schedule',
        )
        parser.add_argument(
            "distance",
            type=int,
            default=200,
            help=
            "Distance range of the query. Used only if a coord is in the query",
        )
        parser.add_argument("since",
                            type=DateTimeFormat(),
                            help="filters objects not valid before this date")
        parser.add_argument("until",
                            type=DateTimeFormat(),
                            help="filters objects not valid after this date")
        parser.add_argument("disable_geojson",
                            type=BooleanType(),
                            default=False,
                            help="remove geojson from the response")
        parser.add_argument("disable_disruption",
                            type=BooleanType(),
                            default=False,
                            help="remove disruptions from the response")

        if is_collection:
            parser.add_argument("filter",
                                type=six.text_type,
                                default="",
                                help="The filter parameter")
        parser.add_argument(
            "tags[]",
            type=six.text_type,
            action="append",
            help=
            "If filled, will restrain the search within the given disruption tags",
        )
        self.collection = collection
        self.get_decorators.insert(0, ManageError())
Exemple #9
0
    def __init__(self):
        ResourceUri.__init__(
            self, output_type_serializer=api.TrafficReportsSerializer)
        ResourceUtc.__init__(self)
        parser_get = self.parsers["get"]
        parser_get.add_argument("depth",
                                type=DepthArgument(),
                                default=1,
                                help="The depth of your object")
        parser_get.add_argument("count",
                                type=default_count_arg_type,
                                default=10,
                                help="Number of objects per page")
        parser_get.add_argument("start_page",
                                type=int,
                                default=0,
                                help="The current page")
        parser_get.add_argument(
            "_current_datetime",
            type=DateTimeFormat(),
            schema_metadata={'default': 'now'},
            hidden=True,
            default=datetime.utcnow(),
            help='The datetime considered as "now". Used for debug, default is '
            'the moment of the request. It will mainly change the output '
            'of the disruptions.',
        )
        parser_get.add_argument(
            "forbidden_id[]",
            type=six.text_type,
            deprecated=True,
            help="DEPRECATED, replaced by `forbidden_uris[]`",
            dest="__temporary_forbidden_id[]",
            default=[],
            action='append',
            schema_metadata={'format': 'pt-object'},
        )
        parser_get.add_argument(
            "forbidden_uris[]",
            type=six.text_type,
            help="forbidden uris",
            dest="forbidden_uris[]",
            default=[],
            action='append',
            schema_metadata={'format': 'pt-object'},
        )
        parser_get.add_argument(
            "distance",
            type=int,
            default=200,
            help=
            "Distance range of the query. Used only if a coord is in the query",
        )
        parser_get.add_argument("disable_geojson",
                                type=BooleanType(),
                                default=False,
                                help="remove geojson from the response")
        parser_get.add_argument(
            "tags[]",
            type=six.text_type,
            hidden=True,
            action="append",
            help=
            "If filled, will restrain the search within the given disruption tags",
        )

        parser_get.add_argument("since",
                                type=DateTimeFormat(),
                                help="use disruptions valid after this date")
        parser_get.add_argument("until",
                                type=DateTimeFormat(),
                                help="use disruptions valid before this date")

        self.collection = 'traffic_reports'
        self.get_decorators.insert(0, ManageError())
        self.get_decorators.insert(1, get_obj_serializer(self))
Exemple #10
0
    def __init__(self, is_collection, collection, *args, **kwargs):
        kwargs['authentication'] = False
        ResourceUri.__init__(self, *args, **kwargs)
        ResourceUtc.__init__(self)
        parser = self.parsers["get"]
        parser.add_argument("start_page",
                            type=int,
                            default=0,
                            help="The page where you want to start")
        parser.add_argument("count",
                            type=default_count_arg_type,
                            default=25,
                            help="Number of objects you want on a page")
        parser.add_argument("depth",
                            type=depth_argument,
                            schema_type=int,
                            default=1,
                            help="The depth of your object")
        parser.add_argument("forbidden_id[]",
                            type=six.text_type,
                            help="DEPRECATED, replaced by `forbidden_uris[]`",
                            dest="__temporary_forbidden_id[]",
                            default=[],
                            action="append")
        parser.add_argument("forbidden_uris[]",
                            type=six.text_type,
                            help="forbidden uris",
                            dest="forbidden_uris[]",
                            default=[],
                            action="append")
        parser.add_argument("external_code",
                            type=six.text_type,
                            help="An external code to query")
        parser.add_argument("headsign",
                            type=six.text_type,
                            help="filter vehicle journeys on headsign")
        parser.add_argument("show_codes",
                            type=BooleanType(),
                            default=False,
                            help="show more identification codes")
        parser.add_argument("odt_level",
                            type=OptionValue(odt_levels),
                            default="all",
                            schema_type=str,
                            schema_metadata={"enum": odt_levels},
                            help="odt level")
        parser.add_argument(
            "_current_datetime",
            type=DateTimeFormat(),
            default=datetime.utcnow(),
            hidden=True,
            help="The datetime used to consider the state of the pt object"
            " Default is the current date and it is used for debug."
            " Note: it will mainly change the disruptions that concern the object"
            " The timezone should be specified in the format,"
            " else we consider it as UTC")
        parser.add_argument(
            "distance",
            type=int,
            default=200,
            help=
            "Distance range of the query. Used only if a coord is in the query"
        )
        parser.add_argument("since",
                            type=DateTimeFormat(),
                            help="filters objects not valid before this date")
        parser.add_argument("until",
                            type=DateTimeFormat(),
                            help="filters objects not valid after this date")
        parser.add_argument("disable_geojson",
                            type=BooleanType(),
                            default=False,
                            help="remove geojson from the response")

        if is_collection:
            parser.add_argument("filter",
                                type=six.text_type,
                                default="",
                                help="The filter parameter")
        self.collection = collection
        self.get_decorators.insert(0, ManageError())