Файловый менеджер - Редактировать - /opt/imh-python/lib/python3.9/site-packages/pynetbox/core/__pycache__/endpoint.cpython-39.pyc
Ðазад
a n�h�O � @ s\ d Z ddlmZmZ ddlmZmZ dZG dd� de�Z G dd� de�Z G d d � d e �Z d S ) a" (c) 2017 DigitalOcean Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. � )�Request� RequestError)�Record� RecordSet� c @ sd e Zd ZdZddd�Zdd� Zddd �Zd d � Zd d � Zdd� Z dd� Z dd� Z dd� Z dd� Z dS )�Endpointa� Represent actions available on endpoints in the Netbox API. Takes ``name`` and ``app`` passed from App() and builds the correct url to make queries to and the proper Response object to return results in. :arg obj api: Takes :py:class:`.Api` created at instantiation. :arg obj app: Takes :py:class:`.App`. :arg str name: Name of endpoint passed to App(). :arg obj,optional model: Custom model for given app. .. note:: In order to call NetBox endpoints with dashes in their names you should convert the dash to an underscore. (E.g. querying the ip-addresses endpoint is done with ``nb.ipam.ip_addresses.all()``.) Nc C s\ | � ||�| _|�dd�| _|| _|j| _|j| _|j| _dj| j|j| jd�| _ d | _ d S )N�_�-z{base_url}/{app}/{endpoint})�base_url�app�endpoint) �_lookup_ret_obj� return_obj�replace�name�apir �token� session_key�format�url�_choices)�selfr r r �modelr r ��/root/rpmbuild/BUILDROOT/imh-python39-modules-3.9.7-92.el8.x86_64/opt/imh-python/lib/python3.9/site-packages/pynetbox/core/endpoint.py�__init__+ s �zEndpoint.__init__c C s* |r"|� � �dd�}t||t�}nt}|S )aS Loads unique Response objects. This method loads a unique response object for an endpoint if it exists. Otherwise return a generic `Record` object. :arg str name: Endpoint name. :arg obj model: The application model that contains unique Record objects. :Returns: Record (obj) r � )�titler �getattrr )r r r �retr r r r 7 s zEndpoint._lookup_ret_objr c C sL |dkr|durt d��td�| j�| j| j| jj| jj||d�}t | |�S )a Queries the 'ListView' of a given endpoint. Returns all objects from an endpoint. :arg int,optional limit: Overrides the max page size on paginated returns. :arg int,optional offset: Overrides the offset on paginated returns. :Returns: A :py:class:`.RecordSet` object. :Examples: >>> devices = nb.dcim.devices.all() >>> for device in devices: ... print(device.name) ... test1-leaf1 test1-leaf2 test1-leaf3 >>> r N�&offset requires a positive limit valuez{}/)�baser r � http_session� threading�limit�offset) � ValueErrorr r r r r r r! r" r )r r# r$ �reqr r r �allJ s � z Endpoint.allc O s� z |d }W n t y" d}Y n0 |sv| jf i |��}t|d�}|sJ|S zt|� td��W n tyt | Y S 0 t|| j| j| j| j j d�}ztt | |�d�W S t y� } z*|j jdkr�W Y d}~dS |�W Y d}~n d}~0 0 dS )a� Queries the DetailsView of a given endpoint. :arg int,optional key: id for the item to be retrieved. :arg str,optional \**kwargs: Accepts the same keyword args as filter(). Any search argument the endpoint accepts can be added as a keyword arg. :returns: A single :py:class:`.Record` object or None :raises ValueError: if kwarg search return more than one value. :Examples: Referencing with a kwarg that only returns one value. >>> nb.dcim.devices.get(name='test1-a3-tor1b') test1-a3-tor1b >>> Referencing with an id. >>> nb.dcim.devices.get(1) test1-edge1 >>> r Nz�get() returned more than one result. Check that the kwarg(s) passed are valid for this endpoint or use filter() or all() instead.)�keyr r r r! i� )� IndexError�filter�nextr% � StopIterationr r r r r r! r r r& � status_code)r �args�kwargsr( �respr r& �er r r �getn s: � � z Endpoint.getc O s� |r|� d|d i� tdd� |D ��r6td�t���d|v rH|�d�nd}d|v r^|�d�nd}|dkrz|durztd ��t|| j| j| j | j j | j j ||d �}t | |�S ) aE Queries the 'ListView' of a given endpoint. Takes named arguments that match the usable filters on a given endpoint. If an argument is passed then it's used as a freeform search argument if the endpoint supports it. :arg str,optional \*args: Freeform search string that's accepted on given endpoint. :arg str,optional \**kwargs: Any search argument the endpoint accepts can be added as a keyword arg. :arg int,optional limit: Overrides the max page size on paginated returns. :arg int,optional offset: Overrides the offset on paginated returns. :Returns: A :py:class:`.RecordSet` object. :Examples: To return a list of objects matching a named argument filter. >>> devices = nb.dcim.devices.filter(role='leaf-switch') >>> for device in devices: ... print(device.name) ... test1-leaf1 test1-leaf2 test1-leaf3 >>> Using a freeform query along with a named argument. >>> devices = nb.dcim.devices.filter('a3', role='leaf-switch') >>> for device in devices: ... print(device.name) ... test1-a3-leaf1 test1-a3-leaf2 >>> Chaining multiple named arguments. >>> devices = nb.dcim.devices.filter(role='leaf-switch', status=True) >>> for device in devices: ... print(device.name) ... test1-leaf2 >>> Passing a list as a named argument adds multiple filters of the same value. >>> device = nb.dcim.devices.filter(role=['leaf-switch', 'spine-switch']) >>> for device in devices: ... print(device.name) ... test1-a3-spine1 test1-a3-spine2 test1-a3-leaf1 >>> �qr c s s | ]}|t v V qd S �N��RESERVED_KWARGS��.0�ir r r � <genexpr>� � z"Endpoint.filter.<locals>.<genexpr>zAA reserved kwarg was passed ({}). Please remove it and try again.r# r$ Nr )�filtersr r r r! r" r# r$ )�update�anyr% r r6 �popr r r r r r! r" r )r r. r/ r# r$ r& r r r r* � s. >��� zEndpoint.filterc sX t � j� j� j� jjd��|r&|d n|�}t|t�rH� fdd�|D �S � � |� j� �S )a� Creates an object on an endpoint. Allows for the creation of new objects on an endpoint. Named arguments are converted to json properties, and a single object is created. NetBox's bulk creation capabilities can be used by passing a list of dictionaries as the first argument. .. note: Any positional arguments will supercede named ones. :arg list \*args: A list of dictionaries containing the properties of the objects to be created. :arg str \**kwargs: key/value strings representing properties on a json object. :returns: A list or single :py:class:`.Record` object depending on whether a bulk creation was requested. :Examples: Creating an object on the `devices` endpoint: >>> device = netbox.dcim.devices.create( ... name='test', ... device_role=1, ... ) >>> Use bulk creation by passing a list of dictionaries: >>> nb.dcim.devices.create([ ... { ... "name": "test1-core3", ... "device_role": 3, ... "site": 1, ... "device_type": 1, ... "status": 1 ... }, ... { ... "name": "test1-core4", ... "device_role": 3, ... "site": 1, ... "device_type": 1, ... "status": 1 ... } ... ]) �r r r r! r c s g | ]}� � |� j� ��qS r �r r r7 �r r r � <listcomp>? r; z#Endpoint.create.<locals>.<listcomp>) r r r r r r! �post� isinstance�listr )r r. r/ r& r rB r �create s 2�� zEndpoint.createc s� g }t |t�s tdt|� ��|D ]n}t |t�rR|�� }|r�|j|d< |�|� q"t |t�r�d|vrttdt |� ��|�|� q"tdt|� ��q"t � j � j � j � jjd��|�}t |t�r· fdd�|D �S � �|� j� �S )a� Bulk updates existing objects on an endpoint. Allows for bulk updating of existing objects on an endpoint. Objects is a list whic contain either json/dicts or Record derived objects, which contain the updates to apply. If json/dicts are used, then the id of the object *must* be included :arg list objects: A list of dicts or Record. :returns: True if the update succeeded :Examples: Updating objects on the `devices` endpoint: >>> device = netbox.dcim.devices.update([ ... {'id': 1, 'name': 'test'}, ... {'id': 2, 'name': 'test2'}, ... ]) >>> True Use bulk update by passing a list of Records: >>> devices = nb.dcim.devices.all() >>> for d in devices: >>> d.name = d.name+'-test' >>> nb.dcim.devices.update(devices) >>> True z/Objects passed must be list[dict|Record] - was �idzid is missing from object: z(Object passed must be dict|Record - was r@ c s g | ]}� � |� j� ��qS r rA r7 rB r r rC | r; z#Endpoint.update.<locals>.<listcomp>)rE rF r% �typer ZupdatesrH �append�dict�strr r r r r r! �patchr )r �objectsZseries�o�datar& r rB r r= B s: � ��� zEndpoint.updatec C s� g }t |t�s,t |t�s,tdtt|�� ��|D ]�}t |t�rJ|�|� q0t |t�rl|�� rl|�t|�� q0t |t �r�t |d�s�td|j d ��|�|j � q0tdtt|�� ��q0t | j | j| j| jjd�}|jdd� |D �d �r�d S d S ) aN Bulk deletes objects on an endpoint. Allows for batch deletion of multiple objects from a single endpoint :arg list objects: A list of either ids or Records or a single RecordSet to delete. :returns: True if bulk DELETE operation was successful. :Examples: Deleting all `devices`: >>> netbox.dcim.devices.delete(netbox.dcim.devices.all(0)) >>> Use bulk deletion by passing a list of ids: >>> netbox.dcim.devices.delete([2, 243, 431, 700]) >>> Use bulk deletion to delete objects eg. when filtering on a `custom_field`: >>> netbox.dcim.devices.delete([ >>> d for d in netbox.dcim.devices.all(0) \ >>> if d.custom_fields.get('field', False) >>> ]) >>> z5objects must be list[str|int|Record]|RecordSet - was rH z Record from 'z0' does not have an id and cannot be bulk deletedz-Invalid object in list of objects to delete: r@ c S s g | ] }d |i�qS )rH r r7 r r r rC � r; z#Endpoint.delete.<locals>.<listcomp>)rP TF)rE rF r r% rL rI �intrJ � isnumericr �hasattrr rH r r r r r! �delete)r rN Z cleaned_idsrO r& r r r rT s@ �� �����zEndpoint.deletec C s� | j r | j S t| j| jj| jj| jjd��� }z|d d }W n" ty` t d� | j���Y n0 i | _ |D ]"}d|| v rl|| d | j |< ql| j S )an Returns all choices from the endpoint. The returned dict is also saved in the endpoint object (in ``_choices`` attribute) so that later calls will return the same data without recurring requests to NetBox. When using ``.choices()`` in long-running applications, consider restarting them whenever NetBox is upgraded, to prevent using stale choices data. :Returns: Dict containing the available choices. :Example (from NetBox 2.8.x): >>> from pprint import pprint >>> pprint(nb.ipam.ip_addresses.choices()) {'role': [{'display_name': 'Loopback', 'value': 'loopback'}, {'display_name': 'Secondary', 'value': 'secondary'}, {'display_name': 'Anycast', 'value': 'anycast'}, {'display_name': 'VIP', 'value': 'vip'}, {'display_name': 'VRRP', 'value': 'vrrp'}, {'display_name': 'HSRP', 'value': 'hsrp'}, {'display_name': 'GLBP', 'value': 'glbp'}, {'display_name': 'CARP', 'value': 'carp'}], 'status': [{'display_name': 'Active', 'value': 'active'}, {'display_name': 'Reserved', 'value': 'reserved'}, {'display_name': 'Deprecated', 'value': 'deprecated'}, {'display_name': 'DHCP', 'value': 'dhcp'}]} >>> )r r � private_keyr! �actions�POSTz/Unexpected format in the OPTIONS response at {}�choices) r r r r r rU r! �options�KeyErrorr% r )r r& Z post_data�propr r r rX � s& � � zEndpoint.choicesc O sZ |r|� d|d i� tdd� |D ��r6td�t���t|| j| j| j| j j d�}|� � S )a� Returns the count of objects in a query. Takes named arguments that match the usable filters on a given endpoint. If an argument is passed then it's used as a freeform search argument if the endpoint supports it. If no arguments are passed the count for all objects on an endpoint are returned. :arg str,optional \*args: Freeform search string that's accepted on given endpoint. :arg str,optional \**kwargs: Any search argument the endpoint accepts can be added as a keyword arg. :Returns: Integer with count of objects returns by query. :Examples: To return a count of objects matching a named argument filter. >>> nb.dcim.devices.count(site='tst1') 5827 >>> To return a count of objects on an entire endpoint. >>> nb.dcim.devices.count() 87382 >>> r3 r c s s | ]}|t v V qd S r4 r5 r7 r r r r: r; z!Endpoint.count.<locals>.<genexpr>z;A reserved {} kwarg was passed. Please remove it try again.)r< r r r r! ) r= r> r% r r6 r r r r r r! Z get_count)r r. r/ r r r r �count� s ���zEndpoint.count)N)r N)�__name__� __module__� __qualname__�__doc__r r r' r2 r* rG r= rT rX r\ r r r r r s $@W==>3r c @ s, e Zd ZdZd dd�Zdd� Zd dd�ZdS ) �DetailEndpointz�Enables read/write operations on detail endpoints. Endpoints like ``available-ips`` that are detail routes off traditional endpoints are handled with this class. Nc C sF || _ || _d�|jj|j|�| _t| j|jj|jj |jj d�| _ d S )Nz {}/{}/{}/r@ ) � parent_obj� custom_returnr r r rH rK r r r r! �request_kwargs)r rb r rc r r r r * s �zDetailEndpoint.__init__c s4 t f i � j��j|d�}� jr0� fdd�|D �S |S )a� The view operation for a detail endpoint Returns the response from NetBox for a detail endpoint. :args \**kwargs: key/value pairs that get converted into url parameters when passed to the endpoint. E.g. ``.list(method='get_facts')`` would be converted to ``.../?method=get_facts``. :returns: A :py:class:`.Record` object or list of :py:class:`.Record` objects created from data retrieved from NetBox. )Z add_paramsc s$ g | ] }� � |� jjj� jj��qS r �rc rb r r r7 rB r r rC E s ��z'DetailEndpoint.list.<locals>.<listcomp>)r rd r2 rc )r r/ r& r rB r rF 5 s �zDetailEndpoint.listc s\ |pi }t f i � j���|�}� jrXt|t�r@� fdd�|D �S � �|� jjj� jj�S |S )a� The write operation for a detail endpoint. Creates objects on a detail endpoint in NetBox. :arg dict/list,optional data: A dictionary containing the key/value pair of the items you're creating on the parent object. Defaults to empty dict which will create a single item with default values. :returns: A :py:class:`.Record` object or list of :py:class:`.Record` objects created from data created in NetBox. c s$ g | ] }� � |� jjj� jj��qS r re )r8 Zreq_itemrB r r rC ^ s ��z)DetailEndpoint.create.<locals>.<listcomp>) r rd rD rc rE rF rb r r )r rP r& r rB r rG M s ��zDetailEndpoint.create)N)N)r] r^ r_ r` r rF rG r r r r ra # s ra c @ s e Zd Zdd� ZdS )�RODetailEndpointc C s t d��d S )Nz+Writes are not supported for this endpoint.)�NotImplementedError)r rP r r r rG l s zRODetailEndpoint.createN)r] r^ r_ rG r r r r rf k s rf N) r` Zpynetbox.core.queryr r Zpynetbox.core.responser r r6 �objectr ra rf r r r r �<module> s H
| ver. 1.1 | |
.
| PHP 8.3.30 | Ð“ÐµÐ½ÐµÑ€Ð°Ñ†Ð¸Ñ Ñтраницы: 0 |
proxy
|
phpinfo
|
ÐаÑтройка