| C:\Perl_PPM\MouseX-Getopt-0.36\blib/lib/MouseX/Getopt.pm |
## In your class package My::App; use Mouse;
with 'MouseX::Getopt';
has 'out' => (is => 'rw', isa => 'Str', required => 1); has 'in' => (is => 'rw', isa => 'Str', required => 1);
# ... rest of the class here
## in your script #!/usr/bin/perl
use My::App;
my $app = My::App->new_with_options(); # ... rest of the script here
## on the command line % perl my_app_script.pl -in file.input -out file.dump
This is a role which provides an alternate constructor for creating objects using parameters passed in from the command line.
This module attempts to DWIM as much as possible with the command line params by introspecting your class's attributes. It will use the name of your attribute as the command line option, and if there is a type constraint defined, it will configure Getopt::Long to handle the option accordingly.
You can use the trait the MouseX::Getopt::Meta::Attribute::Trait manpage or the attribute metaclass the MouseX::Getopt::Meta::Attribute manpage to get non-default commandline option names and aliases.
You can use the trait the MouseX::Getopt::Meta::Attribute::Trait::NoGetopt manpage
or the attribute metaclass the MouseX::Getopt::Meta::Attribute::NoGetopt manpage
to have MouseX::Getopt ignore your attribute in the commandline options.
By default, attributes which start with an underscore are not given commandline argument support, unless the attribute's metaclass is set to the MouseX::Getopt::Meta::Attribute manpage. If you don't want your accessors to have the leading underscore in their name, you can do this:
# for read/write attributes has '_foo' => (accessor => 'foo', ...);
# or for read-only attributes has '_bar' => (reader => 'bar', ...);
This will mean that Getopt will not handle a --foo param, but your
code can still call the foo method.
If your class also uses a configfile-loading role based on
the MouseX::ConfigFromFile manpage, such as the MouseX::SimpleConfig manpage,
the MouseX::Getopt manpage's new_with_options will load the configfile
specified by the --configfile option (or the default you've
given for the configfile attribute) for you.
Options specified in multiple places follow the following precedence order: commandline overrides configfile, which overrides explicit new_with_options parameters.
has 'verbose' => (is => 'rw', isa => 'Bool');
would translate into verbose! as a Getopt::Long option descriptor,
which would enable the following command line options:
% my_script.pl --verbose % my_script.pl --noverbose
=i, =f and =s modifiers as appropriate.
has 'include' => (
is => 'rw',
isa => 'ArrayRef',
default => sub { [] }
);
would translate into includes=s@ as a Getopt::Long option descriptor,
which would enable the following command line options:
% my_script.pl --include /usr/lib --include /usr/local/lib
has 'define' => (
is => 'rw',
isa => 'HashRef',
default => sub { {} }
);
would translate into define=s% as a Getopt::Long option descriptor,
which would enable the following command line options:
% my_script.pl --define os=linux --define vendor=debian
It is possible to create custom type constraint to option spec mappings if you need them. The process is fairly simple (but a little verbose maybe). First you create a custom subtype, like so:
subtype 'ArrayOfInts'
=> as 'ArrayRef'
=> where { scalar (grep { looks_like_number($_) } @$_) };
Then you register the mapping, like so:
MouseX::Getopt::OptionTypeMap->add_option_type_to_map(
'ArrayOfInts' => '=i@'
);
Now any attribute declarations using this type constraint will get the custom option spec. So that, this:
has 'nums' => (
is => 'ro',
isa => 'ArrayOfInts',
default => sub { [0] }
);
Will translate to the following on the command line:
% my_script.pl --nums 5 --nums 88 --nums 199
This example is fairly trivial, but more complex validations are easily possible with a little creativity. The trick is balancing the type constraint validations with the Getopt::Long validations.
Better examples are certainly welcome :)
If you define a custom subtype which is a subtype of one of the standard Supported Type Constraints above, and do not explicitly provide custom support as in Custom Type Constraints above, MouseX::Getopt will treat it like the parent type for Getopt purposes.
For example, if you had the same custom ArrayOfInts subtype
from the examples above, but did not add a new custom option
type for it to the OptionTypeMap, it would be treated just
like a normal ArrayRef type for Getopt purposes (that is,
=s@).
%params and then collect
params from the command line (possibly overriding those in %params)
and then return a newly constructed object.
The special parameter argv, if specified should point to an array
reference with an array to use instead of @ARGV.
If GetOptions in the Getopt::Long manpage fails (due to invalid arguments),
new_with_options will throw an exception.
If the Getopt::Long::Descriptive manpage is installed and any of the following command line params are passed, the program will exit with usage information (and the option's state will be stored in the help_flag attribute). You can add descriptions for each option by including a documentation option for each attribute to document.
--? --help --usage
If you have the Getopt::Long::Descriptive manpage the usage param is also passed to
new as the usage option.
@ARGV array
as it originally existed at the time of new_with_options.
@ARGV elements that
the Getopt::Long manpage did not parse. Note that the real @ARGV is left
un-mangled.
This software is copyright (c) 2012 by Infinity Interactive, Inc.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
| C:\Perl_PPM\MouseX-Getopt-0.36\blib/lib/MouseX/Getopt.pm |