maci docs
  • maci
  • WATCH
    • Quick Start
    • Full Training Series
  • DOCS
    • maci
      • language
        • v1.0.0
      • functions
        • maci.build
        • maci.load
        • maci.loadstr
        • maci.loadattrs
        • maci.loadraw
        • maci.loaddict
        • maci.loadstrdict
        • maci.dump
        • maci.dumpstr
        • maci.dumpraw
      • object
        • methods
          • lock_attr
          • unlock_attr
          • hard_lock_attr
          • map_attr
          • unmap_attr
          • load_attrs
          • get_attrs
          • get_locked_list
          • get_hard_locked_list
          • get_all_maps
          • get_parent_maps
          • get_child_maps
          • get_parent_map_chains
          • is_parent_map
          • is_child_map
      • errors
      • hints
    • json
      • functions
        • maci.jsonload
        • maci.jsonloadstr
        • maci.jsondump
        • maci.jsondumpstr
    • yaml
      • functions
        • maci.yamlload
        • maci.yamlloadstr
        • maci.yamlloadall
        • maci.yamldump
        • maci.yamldumpstr
        • maci.yamldumpall
    • toml
      • functions
        • maci.tomlload
        • maci.tomlloadstr
        • maci.tomldump
        • maci.tomldumpstr
    • ini
      • functions
        • maci.iniload
        • maci.inidump
        • maci.inibuildauto
        • maci.inibuildmanual
    • xml
      • functions
        • maci.xmlload
        • maci.xmlloadstr
        • maci.xmlloaddict
        • maci.xmlloadstrdict
        • maci.xmldump
        • maci.xmldumpstr
        • maci.xmldumpdict
        • maci.xmldumpstrdict
        • maci.xmlbuildmanual
        • maci._defuse_xml_stdlib
    • pickle
      • functions
        • maci.pickleloadbytes
        • maci.pickledumpbytes
    • tools
      • hash functions
        • maci.createhash
        • maci.createfilehash
        • maci.comparefilehash
      • format functions
        • maci.cleanformat
  • Updates
    • Changelog
      • v1.1.0
      • v1.0.0
Powered by GitBook
On this page
  • partner methods
  • parameters & arguments
  1. DOCS
  2. maci
  3. object
  4. methods

lock_attr

lock an attribute name

Last updated 1 year ago

Locks an attribute name from reassignment. Nothing is returned. Attribute names that are locked cannot be reassigned to a new value, but a locked attribute name can be deleted or unlocked (See ). If there is an attempt to reassign an attribute name that is currently locked, an exception will be thrown. Attribute names must already exist to lock them.

You cannot have an attribute name locked and simultaneously. Only one lock type can be used on an attribute name at a time.

Basic Example of locking a name using default positional parameter

data.lock_attr('attr_name')

In this example, we simply lock an attribute name that already exists in the using the lock_attr method and pass a string of the attribute name as an argument to the method to lock the name.

partner methods

Methods that provide related utility to this method

-> Unlock an attribute name -> View all the currently locked attribute names

parameters & arguments

Describes all parameter functionality and accepted data types

attr_name: str

First and only required positional argument. Accepts strings

Use this parameter to pick attribute name to lock

unlock_attr
hard-locked
MaciDataObj
unlock_attr
get_locked_list