(self, *paths: base.cid_t, type: str = "all", **kwargs: base.CommonArgs)
return self._client.request('/pin/ls', args, decoder='json', **kwargs)
Lists objects pinned in the local repository
		
		By default, all pinned objects are returned, but the ``type`` flag or
		arguments can restrict that to a specific pin type or to some specific
		objects respectively. In particular the ``type="recursive"`` argument will
		only list objects added ``.pin.add(…)`` (or similar) and will greatly
		speed processing as obtaining this list does *not* require a complete
		repository metadata scan.
		
		.. code-block:: python
		
			>>> client.pin.ls()
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'},
				'QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e': {'Type': 'recursive'},
				'QmNg5zWpRMxzRAVg7FTQ3tUxVbKj8E … gHPz': {'Type': 'indirect'},
				…
				'QmNiuVapnYCrLjxyweHeuk6Xdqfvts … wCCe': {'Type': 'indirect'}
			}}
			
			>>> # While the above works you should always try to use `type="recursive"`
			>>> # instead as it will greatly speed up processing and only lists
			>>> # explicit pins (added with `.pin.add(…)` or similar), rather than
			>>> # than all objects that won't be removed as part of `.repo.gc()`:
			>>> client.pin.ls(type="recursive")
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'},
				'QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e': {'Type': 'recursive'},
				…
			}}
			
			>>> client.pin.ls('/ipfs/QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz')
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'}}}
			
			>>> client.pin.ls('/ipfs/QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z')
			ipfshttpclient.exceptions.ErrorResponse:
				path '/ipfs/QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z' is not pinned
		
		Parameters
		----------
		paths
			The IPFS paths or CIDs to search for
			
			If none are passed, return information about all pinned objects.
			If any of the passed CIDs is not pinned, then remote will
			return an error and an :exc:`ErrorResponse` exception will be raised.
		type
			The type of pinned keys to list. Can be:
			
			 * ``"direct"``
			 * ``"indirect"``
			 * ``"recursive"``
			 * ``"all"``
		
		Raises
		------
		~ipfsapi.exceptions.ErrorResponse
			Remote returned an error. Remote will return an error
			if any of the passed CIDs is not pinned. In this case,
			the exception will contain 'not pinned' in its args[0].
		
		Returns
		-------
			dict
		
		+------+--------------------------------------------------------------+
		| Keys | Mapping of IPFS object names currently pinned to their types |
		+------+--------------------------------------------------------------+
Lists objects pinned in the local repository
		
		By default, all pinned objects are returned, but the ``type`` flag or
		arguments can restrict that to a specific pin type or to some specific
		objects respectively. In particular the ``type="recursive"`` argument will
		only list objects added ``.pin.add(…)`` (or similar) and will greatly
		speed processing as obtaining this list does *not* require a complete
		repository metadata scan.
		
		.. code-block:: python
		
			>>> client.pin.ls()
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'},
				'QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e': {'Type': 'recursive'},
				'QmNg5zWpRMxzRAVg7FTQ3tUxVbKj8E … gHPz': {'Type': 'indirect'},
				…
				'QmNiuVapnYCrLjxyweHeuk6Xdqfvts … wCCe': {'Type': 'indirect'}
			}}
			
			>>> # While the above works you should always try to use `type="recursive"`
			>>> # instead as it will greatly speed up processing and only lists
			>>> # explicit pins (added with `.pin.add(…)` or similar), rather than
			>>> # than all objects that won't be removed as part of `.repo.gc()`:
			>>> client.pin.ls(type="recursive")
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'},
				'QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e': {'Type': 'recursive'},
				…
			}}
			
			>>> client.pin.ls('/ipfs/QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz')
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'}}}
			
			>>> client.pin.ls('/ipfs/QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z')
			ipfshttpclient.exceptions.ErrorResponse:
				path '/ipfs/QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z' is not pinned
		
		Parameters
		----------
		paths
			The IPFS paths or CIDs to search for
			
			If none are passed, return information about all pinned objects.
			If any of the passed CIDs is not pinned, then remote will
			return an error and an :exc:`ErrorResponse` exception will be raised.
		type
			The type of pinned keys to list. Can be:
			
			 * ``"direct"``
			 * ``"indirect"``
			 * ``"recursive"``
			 * ``"all"``
		
		Raises
		------
		~ipfsapi.exceptions.ErrorResponse
			Remote returned an error. Remote will return an error
			if any of the passed CIDs is not pinned. In this case,
			the exception will contain 'not pinned' in its args[0].
		
		Returns
		-------
			dict
		
		+------+--------------------------------------------------------------+
		| Keys | Mapping of IPFS object names currently pinned to their types |
		+------+--------------------------------------------------------------+
Lists objects pinned in the local repository By default all pinned objects are returned but the type flag or arguments can restrict that to a specific pin type or to some specific objects respectively . In particular the type = recursive argument will only list objects added . pin . add ( … ) ( or similar ) and will greatly speed processing as obtaining this list does * not * require a complete repository metadata scan . .. code - block :: python >>> client . pin . ls () { Keys : { QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz : { Type : recursive } QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e : { Type : recursive } QmNg5zWpRMxzRAVg7FTQ3tUxVbKj8E … gHPz : { Type : indirect } … QmNiuVapnYCrLjxyweHeuk6Xdqfvts … wCCe : { Type : indirect } }} >>> # While the above works you should always try to use type = recursive >>> # instead as it will greatly speed up processing and only lists >>> # explicit pins ( added with . pin . add ( … ) or similar ) rather than >>> # than all objects that won t be removed as part of . repo . gc () : >>> client . pin . ls ( type = recursive ) { Keys : { QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz : { Type : recursive } QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e : { Type : recursive } … }} >>> client . pin . ls ( / ipfs / QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz ) { Keys : { QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz : { Type : recursive }}} >>> client . pin . ls ( / ipfs / QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z ) ipfshttpclient . exceptions . ErrorResponse : path / ipfs / QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z is not pinned Parameters ---------- paths The IPFS paths or CIDs to search for If none are passed return information about all pinned objects . If any of the passed CIDs is not pinned then remote will return an error and an : exc : ErrorResponse exception will be raised . type The type of pinned keys to list . Can be : * direct * indirect * recursive * all Raises ------ ~ipfsapi . exceptions . ErrorResponse Remote returned an error . Remote will return an error if any of the passed CIDs is not pinned . In this case the exception will contain not pinned in its args [ 0 ] . Returns ------- dict + ------ + -------------------------------------------------------------- + | Keys | Mapping of IPFS object names currently pinned to their types | + ------ + -------------------------------------------------------------- +
def ls(self, *paths: base.cid_t, type: str = "all", **kwargs: base.CommonArgs):
		"""Lists objects pinned in the local repository
		
		By default, all pinned objects are returned, but the ``type`` flag or
		arguments can restrict that to a specific pin type or to some specific
		objects respectively. In particular the ``type="recursive"`` argument will
		only list objects added ``.pin.add(…)`` (or similar) and will greatly
		speed processing as obtaining this list does *not* require a complete
		repository metadata scan.
		
		.. code-block:: python
		
			>>> client.pin.ls()
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'},
				'QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e': {'Type': 'recursive'},
				'QmNg5zWpRMxzRAVg7FTQ3tUxVbKj8E … gHPz': {'Type': 'indirect'},
				…
				'QmNiuVapnYCrLjxyweHeuk6Xdqfvts … wCCe': {'Type': 'indirect'}
			}}
			
			>>> # While the above works you should always try to use `type="recursive"`
			>>> # instead as it will greatly speed up processing and only lists
			>>> # explicit pins (added with `.pin.add(…)` or similar), rather than
			>>> # than all objects that won't be removed as part of `.repo.gc()`:
			>>> client.pin.ls(type="recursive")
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'},
				'QmNPZUCeSN5458Uwny8mXSWubjjr6J … kP5e': {'Type': 'recursive'},
				…
			}}
			
			>>> client.pin.ls('/ipfs/QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz')
			{'Keys': {
				'QmNNPMA1eGUbKxeph6yqV8ZmRkdVat … YMuz': {'Type': 'recursive'}}}
			
			>>> client.pin.ls('/ipfs/QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z')
			ipfshttpclient.exceptions.ErrorResponse:
				path '/ipfs/QmdBCSn4UJP82MjhRVwpABww48tXL3 … mA6z' is not pinned
		
		Parameters
		----------
		paths
			The IPFS paths or CIDs to search for
			
			If none are passed, return information about all pinned objects.
			If any of the passed CIDs is not pinned, then remote will
			return an error and an :exc:`ErrorResponse` exception will be raised.
		type
			The type of pinned keys to list. Can be:
			
			 * ``"direct"``
			 * ``"indirect"``
			 * ``"recursive"``
			 * ``"all"``
		
		Raises
		------
		~ipfsapi.exceptions.ErrorResponse
			Remote returned an error. Remote will return an error
			if any of the passed CIDs is not pinned. In this case,
			the exception will contain 'not pinned' in its args[0].
		
		Returns
		-------
			dict
		
		+------+--------------------------------------------------------------+
		| Keys | Mapping of IPFS object names currently pinned to their types |
		+------+--------------------------------------------------------------+
		"""
		kwargs.setdefault("opts", {})["type"] = type
		
		args = tuple(str(p) for p in paths)
		return self._client.request('/pin/ls', args, decoder='json', **kwargs)
def ls ( self , * paths : base . cid_t , type : str = "all" , * * kwargs : base . CommonArgs ) : kwargs . setdefault ( "opts" , { } ) [ "type" ] = type args = tuple ( str ( p ) for p in paths ) return self . _client . request ( '/pin/ls' , args , decoder = 'json' , * * kwargs )