File References

Manage names of Renku objects.

class renku.core.models.refs.LinkReference(client, name)[source]

Manage linked object names.

Method generated by attrs for class LinkReference.

REFS = 'refs'

Define a name of the folder with references in the Renku folder.

classmethod check_ref_format(name, no_slashes=False)[source]

Ensures that a reference name is well formed.

It follows Git naming convention:

  • any path component of it begins with “.”, or
  • it has double dots “..”, or
  • it has ASCII control characters, or
  • it has “:”, “?”, “[“, “", “^”, “~”, SP, or TAB anywhere, or
  • it has “*” anywhere, or
  • it ends with a “/”, or
  • it ends with “.lock”, or
  • it contains a “@{” portion
classmethod create(client, name, force=False)[source]

Create symlink to object in reference path.


Delete the reference at the given path.

classmethod iter_items(client, common_path=None)[source]

Find all references in the repository.

name_validator(attribute, value)[source]

Validate reference name.


Return full reference path.


Return the path we point to relative to the client.

rename(new_name, force=False)[source]

Rename self to a new name.


Set ourselves to the given reference path.