Coverage for src/P4OO/Depot.py: 0%

1###################################################################### 

2# Copyright (c)2012,2015,2024 David L. Armstrong. 

3# 

4# P4OO.Depot.py 

5# 

6###################################################################### 

7 

8from dataclasses import dataclass, field 

9 

10from P4OO._SpecObj import _P4OOSpecObj 

11from P4OO._Set import _P4OOSet 

12 

13@dataclass(unsafe_hash=True) 

14class P4OODepot(_P4OOSpecObj): 

15 """ 

16 Perforce Depot Spec Object 

17 

18 id Required: Yes 

19 

20 Forcible: No 

21 

22 Attributes: 

23 depot (str): Name of the depot 

24 owner (P4OOUser): User that created the depot spec 

25 description (str): Description field 

26 type (str): [`remote`|`local`|`stream`|`spec`|`archive`|`graph`|`trait`] 

27 address (str): P4PORT address for `remote` depot type 

28 suffix (str): filename extension for storing `spec` 

29 map (str): Relative location of the depot subdirectory 

30 date (datetime): Time of last update to the spec 

31 

32 See Also: 

33 Perforce Helix Core Command Reference: 

34 https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_depot.html 

35 """ 

36 

37 # Subclasses must define SPECOBJ_TYPE 

38 _SPECOBJ_TYPE = 'depot' 

39 

40@dataclass 

41class P4OODepotSet(_P4OOSet): 

42 """ `P4OOSet` of `P4OODepot` objects """ 

43 

44 def query(self, depottype: str=None, namefilter: str=None, **kwargs): 

45 """ 

46 Executes `p4 depots` query 

47 

48 Args: 

49 depottype (str, optional): 

50 [`remote`|`local`|`stream`|`spec`|`archive`|`graph`|`trait`] 

51 namefilter (str, optional): Case-sensitive filter on depot name 

52 

53 Returns: 

54 (P4OODepotSet): `P4OOSet` of `P4OODepot` objects matching query 

55 parameters 

56 

57 See Also: 

58 Perforce Helix Core Command Reference: 

59 https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_depots.html 

60 """ 

61 

62 return self._query(setObjType='depots', depottype=depottype, 

63 namefilter=namefilter, **kwargs)