Learning Python---uidoc question

Jean-Marc · September 28, 2023, 7:59am

You are right Aaron, you will get it with time and experience. But here are a few pointers:

When searching in the code base you will get the definition of HOST_APP here

eirannejad/pyRevit/blob/6aa2c493231f4301125f2570dc5efd644691bbad/pyrevitlib/pyrevit/init.py#L424


      
                      command_id (str): command identifier e.g. ID_REVIT_SAVE_AS_TEMPLATE
                  """
                  command_id = UI.RevitCommandId.LookupCommandId(command_id)
                  self.uiapp.PostCommand(command_id)
          
          
          
          try:
              # Create an intance of host application wrapper
              # making sure __revit__ is available
              HOST_APP = _HostApplication()
          except Exception:
              raise Exception('Critical Error: Host software is not supported. '
                              '(__revit__ handle is not available)')
          
          
          # -----------------------------------------------------------------------------
          # Wrapper to access builtin parameters set in scope by C# Script Executor
          # -----------------------------------------------------------------------------
          class _ExecutorParams(object):
              """Private Wrapper that provides runtime environment info."""

all the attached properties here in the _HostApplication Class object

github.com

eirannejad/pyRevit/blob/6aa2c493231f4301125f2570dc5efd644691bbad/pyrevitlib/pyrevit/init.py#L175


      
          """Private namedtuple for passing information about a PostableCommand
          
          Attributes:
              name (str): Postable command name
              key (str): Postable command key string
              id (int): Postable command id
              rvtobj (``RevitCommandId``): Postable command Id Object
          """
          
          
          class _HostApplication(object):
              """Private Wrapper for Current Instance of Revit.
          
              Provides version info and comparison functionality, alongside providing
              info on the active screen, active document and ui-document, available
              postable commands, and other functionality.
          
              Args:
                  host_uiapp (``UIApplication``): Instance of running host.
          
              Example:

The search and the symbol navigation have greatly improved in github in the past year or so. Use it.

Using the new and not yet publicized documentation, you will get there a bit quicker as well
https://ein.sh/pyRevit/reference/pyrevit/
The search is much more performant and the auto documentation itself is grabbing every variable, class, property and definition of the pyrevit libraries, not only some of them randomly like the previous readthedocs one.

and obviously, reading the code of others script does help.

credits to @sanzoghenzo for the refactoring of the documentation process and the quick start forum post

There is plenty of samples, sources for learning. But my best advice is to start small and incrementally grow your scripts and skills. Don’t start with a pet project that is too big.