Skip to main content

spaCy pipeline component for adding cyber meta data to Doc, Token and Span objects.

Project description

spaCy v2.0 extension and pipeline component for adding meta data about IPs, email addresses and URLs to Doc objects. Heavily inspired by spacymoji.

Installation

cyberspacy requires spacy v2.0.0 or higher.

PyPI release coming soon.

Usage

Import the component and initialise it with the shared nlp object (i.e. an instance of Language), which is used to initialise the PhraseMatcher with the shared vocab, and create the match patterns. Then add the component anywhere in your pipeline.

import spacy
from spacy.lang.en import English
from cyberspacy import IPDetector
nlp = English()
ip_detector = IPDetector(nlp)
nlp.add_pipe(ip_detector, first=True)
doc = nlp(u'This is a sentence which contains 2.3.4.5 as an IP address')
assert doc._.has_ipv4 == True
assert doc[0]._.is_ipv4 == False
assert doc[6]._.is_ipv4 == True
assert len(doc._.ipv4) == 1
idx, ipv4_token = doc._.ipv4[0]
assert idx == 6
assert ipv4_token.text == '2.3.4.5'

cyberspacy only cares about the token text, so you can use it on a blank Language instance (it should work for all available languages!), or in a pipeline with a loaded model.

Available attributes

The extension sets attributes on the Doc, Span and Token. You can change the attribute names on initialisation of the extension. For more details on custom components and attributes, see the processing pipelines documentation.

The attributes provided by the IPDetector class are:

Token._.is_ipv4 bool Whether the token is an IPv4 address.
Doc._.has_ipv4 bool Whether the document contains an IPv4 address.
Doc._.ipv4 list (index, token) tuples of the document’s IPv4 addresses.
Span._.has_ipv4 bool Whether the span contains IPv4 addresses.
Span._.ipv4 list (index, token) tuples of the span’s IPv4 addresses.

The attributes provided by the URLDetector class are:

Token._.is_url bool Whether the token is a URL.
Doc._.has_url bool Whether the document contains a URL.
Doc._.url list (index, token) tuples of the document’s URLs.
Span._.has_url bool Whether the span contains a URL.
Span._.url list (index, token) tuples of the span’s URLs.

The attributes provided by the EmailDetector class are:

Token._.is_email_addr bool Whether the token is an email address.
Doc._.has_email_addr bool Whether the document contains an email address.
Doc._.email_addr list (index, token) tuples of the document’s email addresses.
Span._.has_email_addr bool Whether the span contains an email address.
Span._.email_addr list (index, token) tuples of the span’s email addresses.

Project details


Release history Release notifications

This version

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cyberspacy, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size cyberspacy-1.0.0-py3-none-any.whl (9.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size cyberspacy-1.0.0.tar.gz (5.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page