7583613459

Committed 19 Jan 2024 12:14PM UTC coverage: 93.536% (+0.005%) from 93.531%

Build # 7583613459

Build Type

push

github

Committed by

web-flow

Commit Message

fix: Update exception file get download URL (#866)

* fix: Update exception file get download URL

* fix: Update exception file get download URL

Run Details

3 of 3 new or added lines in 1 file covered. (100.0%)

3473 of 3713 relevant lines covered (93.54%)

1.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

71.43

/boxsdk/object/cloneable.py

from typing import TYPE_CHECKING, NoReturn

if TYPE_CHECKING:
    from boxsdk.object.user import User
    from boxsdk.session.session import Session


class Cloneable:
    """
    Cloneable interface to be implemented by endpoint objects that should have ability to be cloned, but with a
    different session member if desired.
    """

    def as_user(self, user: 'User') -> 'Cloneable':
        """
        Returns a new endpoint object with default headers set up to make requests as the specified user.

        :param user:
            The user to impersonate when making API requests.
        """
        return self.clone(self.session.as_user(user))

    def with_shared_link(self, shared_link: str, shared_link_password: str) -> 'Cloneable':
        """
        Returns a new endpoint object with default headers set up to make requests using the shared link for auth.

        :param shared_link:
            The shared link.
        :param shared_link_password:
            The password for the shared link.
        """
        return self.clone(self.session.with_shared_link(shared_link, shared_link_password))

    def clone(self, session: 'Session' = None) -> NoReturn:
        """
        Returns a copy of this cloneable object using the specified session.

        :param session:
            The Box session used to make requests.
        """
        raise NotImplementedError

    @property
    def session(self) -> NoReturn:
        """
        Return the Box session being used to make requests.
        """
        raise NotImplementedError

1	from typing import TYPE_CHECKING, NoReturn	2✔
2
3	if TYPE_CHECKING:	2✔
4	from boxsdk.object.user import User	×
5	from boxsdk.session.session import Session	×
6
7
8	class Cloneable:	2✔
9	"""
10	Cloneable interface to be implemented by endpoint objects that should have ability to be cloned, but with a
11	different session member if desired.
12	"""
13
14	def as_user(self, user: 'User') -> 'Cloneable':	2✔
15	"""
16	Returns a new endpoint object with default headers set up to make requests as the specified user.
17
18	:param user:
19	The user to impersonate when making API requests.
20	"""
21	return self.clone(self.session.as_user(user))	2✔
22
23	def with_shared_link(self, shared_link: str, shared_link_password: str) -> 'Cloneable':	2✔
24	"""
25	Returns a new endpoint object with default headers set up to make requests using the shared link for auth.
26
27	:param shared_link:
28	The shared link.
29	:param shared_link_password:
30	The password for the shared link.
31	"""
32	return self.clone(self.session.with_shared_link(shared_link, shared_link_password))	2✔
33
34	def clone(self, session: 'Session' = None) -> NoReturn:	2✔
35	"""
36	Returns a copy of this cloneable object using the specified session.
37
38	:param session:
39	The Box session used to make requests.
40	"""
41	raise NotImplementedError	×
42
43	@property	2✔
44	def session(self) -> NoReturn:	2✔
45	"""
46	Return the Box session being used to make requests.
47	"""
48	raise NotImplementedError	×

box / box-python-sdk / 7583613459

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous