Zii"dZddlmZddlZddlZddlmZmZddlm Z ddl m Z m Z m Z erddl mZgd Zd e e e fDZd'dZ d(d)dZd*d+dZd*d,dZ d(d-dZ d(d.d Z d(d/d$Zd0d1d%ZGd&deZdS)2zB Python Frontmatter: Parse and manage posts with YAML frontmatter ) annotationsN) TYPE_CHECKINGIterable)u) YAMLHandler JSONHandler TOMLHandler) BaseHandler)parseloadloadsdumpdumpsc&g|]}||SN).0Handlers O/root/projects/butler/venv/lib/python3.11/site-packages/frontmatter/__init__.py rs.    GIItextstrhandlersIterable[BaseHandler]returnBaseHandler | NonecB|D]}||r|cSdS)a Figure out which handler to use, based on metadata. Returns a handler instance or None. ``text`` should be unicode text about to be parsed. ``handlers`` is a dictionary where keys are opening delimiters and values are handler instances. N)detect)rrhandlers r detect_formatr"s< >>$   NNN  4rutf-8encodingr!defaultsobjecttuple[dict[str, object], str]c t||}|}|pt|t}|||fS ||\}}n#t $r||fcYSwxYw||}t|tr| |||fS)a Parse text with frontmatter, return metadata and content. Pass in optional metadata defaults as keyword args. If frontmatter is not found, returns an empty metadata dictionary (or defaults) and original text content. .. testsetup:: * >>> import frontmatter .. doctest:: >>> with open('tests/yaml/hello-world.txt') as f: ... metadata, content = frontmatter.parse(f.read()) >>> print(metadata['title']) Hello, world! ) rstripcopyr"rsplit ValueErrorr isinstancedictupdate)rr$r!r%metadatafmcontentfm_datas rr r 0s4 T8   " " $ $D}}H6tX66G~mmD)) GG ~ ll2G'4  !   W]]__ $$sA..A?>A?fdstr | io.IOBaseboolct|dr|}nBtj|d|5}|}dddn #1swxYwYt ||S)a Check if a file-like object or filename has a frontmatter, return True if exists, False otherwise. If it contains a frontmatter but it is empty, return True as well. .. doctest:: >>> frontmatter.check('tests/yaml/hello-world.txt') True readrN)hasattrr8codecsopenchecks)r4r$rfs rcheckr?csr6wwyy[S( + + q6688D                $ ! !!AA!$A!cTt||}t|tdkS)a< Check if a text (binary or unicode) has a frontmatter, return True if exists, False otherwise. If it contains a frontmatter but it is empty, return True as well. .. doctest:: >>> with open('tests/yaml/hello-world.txt') as f: ... frontmatter.checks(f.read()) True N)rr"r)rr$s rr=r=zs( T8  D x ( (D 00rPostc t|dr|}nBtj|d|5}|}dddn #1swxYwY|pt |t }t |||fi|S)a% Load and parse a file-like object or filename, return a :py:class:`post `. .. doctest:: >>> post = frontmatter.load('tests/yaml/hello-world.txt') >>> with open('tests/yaml/hello-world.txt') as f: ... post = frontmatter.load(f) r8r9N)r:r8r;r<r"rr)r4r$r!r%rr>s rr r s"r6wwyy[S( + + q6688D               6tX66G x 5 5H 5 55r@c t||}|pt|t}t|||fi|\}}t ||fi|S)z Parse text (binary or unicode) and return a :py:class:`post `. .. doctest:: >>> with open('tests/yaml/hello-world.txt') as f: ... post = frontmatter.loads(f.read()) )rr"rr rB)rr$r!r%r0r2s rrrs] T8  D6tX66GdHgBBBBHg  - -H - --rpostkwargsNonec t||fi|}t|dr*|||dSt j|d|5}||ddddS#1swxYwYdS)ak Serialize :py:class:`post ` to a string and write to a file-like object. Text will be encoded on the way out (utf-8 by default). :: >>> from io import BytesIO >>> post = frontmatter.load('tests/yaml/hello-world.txt') >>> f = BytesIO() >>> frontmatter.dump(post, f) >>> print(f.getvalue().decode('utf-8')) --- layout: post title: Hello, world! --- Well, hello there, world. .. testcode:: from io import BytesIO post = frontmatter.load('tests/yaml/hello-world.txt') f = BytesIO() frontmatter.dump(post, f) print(f.getvalue().decode('utf-8')) .. testoutput:: --- layout: post title: Hello, world! --- Well, hello there, world. writewN)rr:rIencoder;r<)rEr4r$r!rFr2r>s rrrsXD',,V,,Gr7 ))*****[S( + + q GGG                     sBB Bc `|t|ddp t}|j|fi|S)a Serialize a :py:class:`post ` to a string and return text. This always returns unicode text, which can then be encoded. Passing ``handler`` will change how metadata is turned into text. A handler passed as an argument will override ``post.handler``, with :py:class:`YAMLHandler ` used as a default. :: >>> post = frontmatter.load('tests/yaml/hello-world.txt') >>> print(frontmatter.dumps(post)) # doctest: +NORMALIZE_WHITESPACE --- layout: post title: Hello, world! --- Well, hello there, world. .. testcode:: post = frontmatter.load('tests/yaml/hello-world.txt') print(frontmatter.dumps(post)) .. testoutput:: --- layout: post title: Hello, world! --- Well, hello there, world. Nr!)getattrrformat)rEr!rFs rrrs>H$ 400AKMM 7>$ ) )& ) ))rcpeZdZdZ d d!d Zd"d Zd#dZd$dZd%dZd&dZ d'dZ d d(dZ d)dZ d*dZ d+dZdS),rBa} A post contains content and metadata from Front Matter. This is what gets returned by :py:func:`load ` and :py:func:`loads `. Passing this to :py:func:`dump ` or :py:func:`dumps ` will turn it back into text. For convenience, metadata values are available as proxied item lookups. Nr2rr!rr0r&rrGc Jt||_||_||_dSr)rr2r0r!)selfr2r!r0s r__init__z Post.__init__&s#7||    rnamec|j|S)zGet metadata keyr0rQrSs r __getitem__zPost.__getitem__-s}T""ritemr6c||jvS)zCheck metadata contains keyrU)rQrXs r __contains__zPost.__contains__1st}$$rvaluec||j|<dS)zSet a metadata keyNrU)rQrSr[s r __setitem__zPost.__setitem__5s# drc|j|=dS)zDelete a metadata keyNrUrVs r __delitem__zPost.__delitem__9s M$   rbytesc6|jdS)Nr#)r2rKrQs r __bytes__zPost.__bytes__=s|""7+++rc|jSr)r2rbs r__str__z Post.__str__@s |rkeydefaultc8|j||S)zGet a key, fallback to default)r0get)rQrfrgs rrizPost.getCs}  g...r Iterable[str]c4|jS)zReturn metadata keys)r0keysrbs rrlz Post.keysGs}!!###rIterable[object]c4|jS)zReturn metadata values)r0valuesrbs rroz Post.valuesKs}##%%%rdict[str, object]cL|j}|j|d<|S)zPost as a dict, for serializingr2)r0r*r2)rQds rto_dictz Post.to_dictOs% M   |) rr)r2rr!rr0r&rrG)rSrrr&)rXr&rr6)rSrr[r&rrG)rSrrrG)rr`)rr)rfrrgr&rr&)rrj)rrm)rrp)__name__ __module__ __qualname____doc__rRrWrZr]r_rcrerirlrorsrrrrBrBs ;?####%%%%$$$$    ,,,,/////$$$$&&&&r)rrrrrr)r#N) rrr$rr!rr%r&rr')r#)r4r5r$rrr6)rrr$rrr6) r4r5r$rr!rr%r&rrB) rrr$rr!rr%r&rrB) rErBr4r5r$rr!rrFr&rrGr)rErBr!rrFr&rr)rw __future__rr;iotypingrrutilrdefault_handlersrr r r __all__rr"r r?r=r rrrr&rBrrrr~s#""""" ********CCCCCCCCCC.------ 6 5 5  k:   ("&0%0%0%0%0%f""""".11111("&66666<"&.....0"& 22222j'*'*'*'*'*T77777677777r