Skip to content

P4OO.User#

P4OOUser dataclass #

Bases: _P4OOSpecObj

Perforce User Spec Object

id Required: No

Forcible: Yes

Attributes:

Name Type Description
user str

Username of the user

type str

[service|operator|standard] Type of user

fullname str

Full name of the user

email str

Email address of the user

jobview str

Jobs to include in changelist creation

password str

P4PASSWD setting is required?

authmethod str

[perforce|perforce+2fa|ldap|ldap+2fa]

reviews str

Depot files to be reviewed by user

update datetime

Time of last update to the spec

access datetime

Time of last access of the spec

See Also

Perforce Helix Core Command Reference: https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_user.html

deleteWithVengeance() #

Performs all operations necessary to remove a user.

  • Revert open files in all clients
  • Remove all pending changes
  • Remove all clients
  • Remove user spec

Returns:

Type Description
Boolean

Result from _P4OOSpecObj.deleteSpec()

See Also

Perforce Helix Core Knowledge Base: https://portal.perforce.com/s/article/2543

listChanges(status=None, maxresults=None) #

Executes p4 changes -u <self> -s <status> -m <maxresults> query

Parameters:

Name Type Description Default
maxresults int

Return only the first results

None
status str

['pending, 'submitted', or 'shelved']

None

Returns:

Type Description
P4OOChangeSet

P4OOSet of P4OOChange objects matching query parameters

See Also

Perforce Helix Core Command Reference: https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_changes.html

listClients() #

Executes p4 clients -u <self> query

Returns:

Type Description
P4OOClientSet

P4OOSet of P4OOClient objects owned by user

See Also

Perforce Helix Core Command Reference: https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_clients.html

listOpenedFiles(client=None) #

Return a P4OOFileSet of files opened by this user in the specified client workspace.

P4OOUserSet dataclass #

Bases: _P4OOSet

P4OOSet of P4OOUser objects

query(allusers=None, longoutput=None, maxresults=None, users=None, **kwargs) #

Executes p4 users query

Parameters:

Name Type Description Default
allusers bool

include service users in results

None
longoutput bool

include the full changelist descriptions

None
maxresults int

Return only the first [max] results

None
users P4OOUserSet | P4OOUserFile | str

The set of users to query

None

Returns:

Type Description
P4OOUserSet

P4OOSet of P4OOUser objects matching query parameters

See Also

Perforce Helix Core Command Reference: https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_users.html