Methods¶

new

Creates a new instance from a details file.

The constructor can be passed either the path to the "02packages.details.txt.gz" file, a path to an ungzipped version of this file, or a scalar containing the entire uncompressed contents of the file.

Note that this module does not concern itself with downloading this file. You should do this yourself. For example:

   use LWP::Simple qw(get);
   my $data = get("http://www.cpan.org/modules/02packages.details.txt.gz");
   my $p = Parse::CPAN::Packages->new($data);
    

If you have a configured CPAN, then there's usually already a cached file available:

   use CPAN;
   $CPAN::Be_Silent = 1;
   CPAN::HandleConfig->load;
   my $file = $CPAN::Config->{keep_source_where} . "/modules/02packages.details.txt.gz";
   my $p = Parse::CPAN::Packages->new($file);
    

package($packagename)

Returns a "Parse::CPAN::Packages::Package" that represents the named package.

  my $p = Parse::CPAN::Packages->new($gzfilename);
  my $package = $p->package("Acme::Colour");
    

packages()

Returns a list of Parse::CPAN::Packages::Package objects representing all the packages that were extracted from the file.

package_count()

Returns the number of packages stored.

distribution($filename)

Returns a Parse::CPAN::Packages::Distribution object that represents the filename passed:

  my $p = Parse::CPAN::Packages->new($gzfilename);
  my $dist = $p->distribution('L/LB/LBROCARD/Acme-Colour-1.00.tar.gz');
    

distributions()

Returns a list of Parse::CPAN::Packages::Distribution objects representing all the known distributions.

distribution_count()

Returns the number of distributions stored.

latest_distribution($distname)

Returns the "Parse::CPAN::Packages::Distribution" object that represents the latest distribution for the named disribution passed, that is to say it returns the distribution that has the highest version number (as determined by version.pm or number comparison if that fails):

  my $p = Parse::CPAN::Packages->new($gzfilename);
  my $dist = $p->distribution('Acme-Color');
    

latest_distrbutions()

Returns a list of Parse::CPAN::Packages::Distribution objects representing all the latest distributions.

latest_distribution_count()

Returns the number of distributions stored.

Preamble Methods¶

These methods return the information from the preamble at the start of the file. They return undef if for any reason no matching preamble line was found.

file()

url()

description()

columns()

intended_for()

written_by()

line_count()

last_updated()

Addtional Methods¶

These are additional methods that you may find useful.

parse($filename)

Parses the filename. Works in a similar fashion to the the constructor (i.e. you can pass it a filename for a compressed/1uncompressed file, a uncompressed scalar containing the file. You can also pass nothing to indicate to load the compressed file from the current working directory.)

Note that each time this function is run the packages and distribtions found will be "added" to the current list of packages.

add_quick($package_name, $package_version, $prefix)

Quick way of adding a new package and distribution.

add_package($package_obj)

Adds a package. Note that you'll probably want to add the corrisponding distribution for that package too (it's not done automatically.)

add_distribution($distribution_obj)

Adds a distribution. Note that you'll probably want to add the corresponding packages for that distribution too (it's not done automatically.)

distribution_from_prefix($prefix)

Returns a distribution given a prefix.

latest_distributions

Returns all the latest distributions:

  my @distributions = $p->latest_distributions;