Edit File: Parse::CPAN::Meta.3pm
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" ======================================================================== .\" .IX Title "inc::Parse::CPAN::Meta 3" .TH inc::Parse::CPAN::Meta 3 "2015-04-05" "perl v5.10.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Parse::CPAN::Meta \- Parse META.yml and META.json CPAN metadata files .SH "VERSION" .IX Header "VERSION" version 1.4405 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& ############################################# \& # In your file \& \& \-\-\- \& name: My\-Distribution \& version: 1.23 \& resources: \& homepage: "http://example.com/dist/My\-Distribution" \& \& \& ############################################# \& # In your program \& \& use Parse::CPAN::Meta; \& \& my $distmeta = Parse::CPAN::Meta\->load_file(\*(AqMETA.yml\*(Aq); \& \& # Reading properties \& my $name = $distmeta\->{name}; \& my $version = $distmeta\->{version}; \& my $homepage = $distmeta\->{resources}{homepage}; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBParse::CPAN::Meta\fR is a parser for \fI\s-1META\s0.json\fR and \fI\s-1META\s0.yml\fR files, using \&\s-1JSON::PP\s0 and/or CPAN::Meta::YAML. .PP \&\fBParse::CPAN::Meta\fR provides three methods: \f(CW\*(C`load_file\*(C'\fR, \f(CW\*(C`load_json_string\*(C'\fR, and \f(CW\*(C`load_yaml_string\*(C'\fR. These will read and deserialize \s-1CPAN\s0 metafiles, and are described below in detail. .PP \&\fBParse::CPAN::Meta\fR provides a legacy \s-1API\s0 of only two functions, based on the \s-1YAML\s0 functions of the same name. Wherever possible, identical calling semantics are used. These may only be used with \s-1YAML\s0 sources. .PP All error reporting is done with exceptions (die'ing). .PP Note that \s-1META\s0 files are expected to be in \s-1UTF\-8\s0 encoding, only. When converted string data, it must first be decoded from \s-1UTF\-8\s0. .SH "METHODS" .IX Header "METHODS" .SS "load_file" .IX Subsection "load_file" .Vb 1 \& my $metadata_structure = Parse::CPAN::Meta\->load_file(\*(AqMETA.json\*(Aq); \& \& my $metadata_structure = Parse::CPAN::Meta\->load_file(\*(AqMETA.yml\*(Aq); .Ve .PP This method will read the named file and deserialize it to a data structure, determining whether it should be \s-1JSON\s0 or \s-1YAML\s0 based on the filename. On Perl 5.8.1 or later, the file will be read using the \*(L":utf8\*(R" \s-1IO\s0 layer. .SS "load_yaml_string" .IX Subsection "load_yaml_string" .Vb 1 \& my $metadata_structure = Parse::CPAN::Meta\->load_yaml_string($yaml_string); .Ve .PP This method deserializes the given string of \s-1YAML\s0 and returns the first document in it. (\s-1CPAN\s0 metadata files should always have only one document.) If the source was \s-1UTF\-8\s0 encoded, the string must be decoded before calling \&\f(CW\*(C`load_yaml_string\*(C'\fR. .SS "load_json_string" .IX Subsection "load_json_string" .Vb 1 \& my $metadata_structure = Parse::CPAN::Meta\->load_json_string($json_string); .Ve .PP This method deserializes the given string of \s-1JSON\s0 and the result. If the source was \s-1UTF\-8\s0 encoded, the string must be decoded before calling \&\f(CW\*(C`load_json_string\*(C'\fR. .SS "yaml_backend" .IX Subsection "yaml_backend" .Vb 1 \& my $backend = Parse::CPAN::Meta\->yaml_backend; .Ve .PP Returns the module name of the \s-1YAML\s0 serializer. See \*(L"\s-1ENVIRONMENT\s0\*(R" for details. .SS "json_backend" .IX Subsection "json_backend" .Vb 1 \& my $backend = Parse::CPAN::Meta\->json_backend; .Ve .PP Returns the module name of the \s-1JSON\s0 serializer. This will either be \s-1JSON::PP\s0 or \s-1JSON\s0. Even if \f(CW\*(C`PERL_JSON_BACKEND\*(C'\fR is set, this will return \s-1JSON\s0 as further delegation is handled by the \s-1JSON\s0 module. See \*(L"\s-1ENVIRONMENT\s0\*(R" for details. .SH "FUNCTIONS" .IX Header "FUNCTIONS" For maintenance clarity, no functions are exported. These functions are available for backwards compatibility only and are best avoided in favor of \&\f(CW\*(C`load_file\*(C'\fR. .SS "Load" .IX Subsection "Load" .Vb 1 \& my @yaml = Parse::CPAN::Meta::Load( $string ); .Ve .PP Parses a string containing a valid \s-1YAML\s0 stream into a list of Perl data structures. .SS "LoadFile" .IX Subsection "LoadFile" .Vb 1 \& my @yaml = Parse::CPAN::Meta::LoadFile( \*(AqMETA.yml\*(Aq ); .Ve .PP Reads the \s-1YAML\s0 stream from a file instead of a string. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .SS "\s-1PERL_JSON_BACKEND\s0" .IX Subsection "PERL_JSON_BACKEND" By default, \s-1JSON::PP\s0 will be used for deserializing \s-1JSON\s0 data. If the \&\f(CW\*(C`PERL_JSON_BACKEND\*(C'\fR environment variable exists, is true and is not \&\*(L"\s-1JSON::PP\s0\*(R", then the \s-1JSON\s0 module (version 2.5 or greater) will be loaded and used to interpret \f(CW\*(C`PERL_JSON_BACKEND\*(C'\fR. If \s-1JSON\s0 is not installed or is too old, an exception will be thrown. .SS "\s-1PERL_YAML_BACKEND\s0" .IX Subsection "PERL_YAML_BACKEND" By default, CPAN::Meta::YAML will be used for deserializing \s-1YAML\s0 data. If the \f(CW\*(C`PERL_YAML_BACKEND\*(C'\fR environment variable is defined, then it is interpreted as a module to use for deserialization. The given module must be installed, must load correctly and must implement the \f(CW\*(C`Load()\*(C'\fR function or an exception will be thrown. .SH "SUPPORT" .IX Header "SUPPORT" .SS "Bugs / Feature Requests" .IX Subsection "Bugs / Feature Requests" Please report any bugs or feature requests through the issue tracker at <https://rt.cpan.org/Public/Dist/Display.html?Name=Parse\-CPAN\-Meta>. You will be notified automatically of any progress on your issue. .SS "Source Code" .IX Subsection "Source Code" This is open source software. The code repository is available for public review and contribution under the terms of the license. .PP <http://github.com/Perl\-Toolchain\-Gang/Parse\-CPAN\-Meta> .PP .Vb 1 \& git clone git://github.com/Perl\-Toolchain\-Gang/Parse\-CPAN\-Meta.git .Ve .SH "AUTHOR" .IX Header "AUTHOR" Adam Kennedy <adamk@cpan.org> .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 David Golden <dagolden@cpan.org> .IP "\(bu" 4 Joshua ben Jore <jjore@cpan.org> .IP "\(bu" 4 Ricardo \s-1SIGNES\s0 <rjbs@cpan.org> .IP "\(bu" 4 Steffen M�ller <smueller@cpan.org> .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 by Adam Kennedy and Contributors. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Back to File Manager