summaryrefslogtreecommitdiffstats
path: root/python/macholib/doc/dylib.rst
blob: 9696802121cb250199c0ded99bd72d473f1a67e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
:mod:`macholib.dylib` --- Generic dylib path manipulation
=========================================================

.. module:: macholib.dylib
   :synopsis: Generic dylib path manipulation

This module defines a function :func:`dylib_info` that can extract
useful information from the name of a dynamic library.

.. function:: dylib_info(filename)

   A dylib name can take one of the following four forms:

   * ``Location/Name.SomeVersion_Suffix.dylib``

   * ``Location/Name.SomeVersion.dylib``

   * ``Location/Name_Suffix.dylib``

   * ``Location/Name.dylib``

   Returns None if not found or a mapping equivalent to::
   
     dict(
         location='Location',
         name='Name.SomeVersion_Suffix.dylib',
         shortname='Name',
         version='SomeVersion',
         suffix='Suffix',
     )

   .. note:: *SomeVersion* and *Suffix* are optional and my be ``None``
      if not present.